Skip to content

Revamp SCI Docs with GitLab, ADO, and PR Comments Content #30586

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

markazerdd
Copy link
Contributor

What does this PR do? What is the motivation?

Revamps the SCI docs to add more info for the GitLab and Azure DevOps integrations and to clean up the Usage section and include PR Comments in its contents

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

@markazerdd markazerdd requested a review from a team as a code owner July 20, 2025 22:32
@github-actions github-actions bot added Images Images are added/removed with this PR Guide Content impacting a guide labels Jul 20, 2025
Copy link
Contributor

github-actions bot commented Jul 20, 2025

📝 Documentation Team Review Required

This pull request requires approval from the @DataDog/documentation team before it can be merged.

Please ensure your changes follow our documentation guidelines and wait for a team member to review and approve your changes.

Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@avidal avidal force-pushed the markazerdd/sci-revamp branch from c2d689b to 8839137 Compare July 21, 2025 13:47
@joepeeples joepeeples self-assigned this Jul 21, 2025
@joepeeples joepeeples added the editorial review Waiting on a more in-depth review label Jul 21, 2025
@joepeeples
Copy link
Contributor

joepeeples commented Jul 21, 2025

Opened DOCS-11572 and assigned myself to follow up with editorial review.

Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for preparing these updates! Several of these comments are just repeated instances of the same edit on multiple tabs, etc. Let me know when you're ready for another quick re-review and approval!

Co-authored-by: Joe Peeples <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review Guide Content impacting a guide Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants