-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add GitHub PRs to the Static Analysis integrations #20981
Add GitHub PRs to the Static Analysis integrations #20981
Conversation
Preview links (active after the
|
Co-authored-by: Mark Azer <[email protected]>
Should not be merged yet, but is ready for docs team review. |
Co-authored-by: Mark Azer <[email protected]>
Had some feedback on this @markazerdd @jhgilbert From the user's POV, the content in the first and third sections below have a lot of overlap. We could put the prerequisite blurb under the "Configure a GitHub App" heading? For Step 4 of the "Subscribe to events", we check the "Pull Request review comment" box which is wrong. We need users to check the "Pull Request" box only. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added my review comment separately, but there's one change required.
@dastrong Thanks for the feedback -- I think the user will be frustrated if they work through the prerequisite link and then have to revisit the same GitHub App to update it, so I rephrased that part to keep the user on the page instead. Let me know if this works better for you. CC @markazerdd |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, some copy suggestions + small anchor link fix!
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
Co-authored-by: Austin Lai <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
* Add GitHub PRs to the integrations * Update _index.md * Update content/en/continuous_integration/static_analysis/_index.md Co-authored-by: Mark Azer <[email protected]> * Update _index.md * Write feature overview for GitHub source code management * Sketch in content outline * Add page to the TOC * Add section on configuring a GitHub App * Add product shot * Update product screenshot * Flesh out GitHub App instructions * Finish first draft of instructions * Update content/en/static_analysis/github_source_code_management.md Co-authored-by: Mark Azer <[email protected]> * Update content/en/static_analysis/github_source_code_management.md Co-authored-by: Mark Azer <[email protected]> * Update content/en/static_analysis/github_source_code_management.md Co-authored-by: Mark Azer <[email protected]> * Update content/en/static_analysis/github_source_code_management.md Co-authored-by: Mark Azer <[email protected]> * Update content/en/static_analysis/github_source_code_management.md Co-authored-by: Mark Azer <[email protected]> * Integrate feedback * Rename file * Update URL * Integrate feedback * Update identifier * Update _index.md * Tweak instructions * Integrate feedback * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Update content/en/static_analysis/github_pull_requests.md Co-authored-by: Austin Lai <[email protected]> * Spacing Nit --------- Co-authored-by: Mark Azer <[email protected]> Co-authored-by: Austin Lai <[email protected]>
What does this PR do? What is the motivation?
DOCS-5928, adds GitHub PRs to the integrations for Static Analysis.
Merge instructions
Additional notes