Updating existing user documentation with more details #9354
Conversation
|
Need to fix that image with the weird spacing. |
markwilkie
left a comment
There was a problem hiding this comment.
This is great Missy - thanks!
| The Build Analysis Check is a service to improve the GitHub Pull Request experience by highlighting build and test information most helpful to .NET developers. Its goal is to make Pull Request results more actionable. | ||
|
|
||
| ## What does it do? | ||
|
|
There was a problem hiding this comment.
@ulisesh what should we add in here about Known Issues?
| - Link to the log of the specific step that failed | ||
| - Link to the Azure DevOps Test History for the pipeline | ||
| - Link to test history of the specific test | ||
| - Link to the Helix artifacts produced by a test |
There was a problem hiding this comment.
I would add the known issue mention here too
|
|
||
| Dive into the Known Issues documentation [here](KnownIssues.md). | ||
|
|
||
| ## Unique Build Failures |
There was a problem hiding this comment.
Is it worth adding some caveats to this? In other words, expand on the limitations?
There was a problem hiding this comment.
@AlitzelMendez @garath @ChadNedzlek anything you can think of that we should include in here for limitations on this? (I can link back to the blurb about technical limitations if that seems sufficient.)
| Each Build Analysis page also includes a "was this helpful" link. This allows you to call out specific highlights or lowlights in your experience with the check. This feedback is then used by the Dev WF team to refine the analysis. | ||
| Each Build Analysis page also includes a "was this helpful" link. This allows you to call out specific highlights or lowlights in your experience with the check. This feedback is then used by the Dev WF team to refine the analysis. | ||
|
|
||
| ## Known Issues |
There was a problem hiding this comment.
Maybe a bit here about the fact that the actual issue keep track of the number of failed builds (like runfo). Also, there's a dashboard....
There was a problem hiding this comment.
@ulisesh could you write a blurb to put in here about Known Issues. The users can click on the link to the Known Issue's doc for more information.
|
This PR has been open for quite some time and has information that is useful for customers. Merging this now. Outstanding feedback to be handled by: #9814 |
This PR expands upon the existing documentation as we've rolled out more features since it was originally created. Feedback I'm looking for from reviewers:
Thanks everyone!