Skip to content

INA-7891: Extract off-topic sections from "Describe incident" documentation #30917

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

Merged
merged 11 commits into from
Aug 12, 2025

Conversation

cperryk
Copy link
Contributor

@cperryk cperryk commented Aug 5, 2025

What does this PR do? What is the motivation?

This PR updates Incident Management documentation to extract content from the "Describe incident" page that has nothing to do with describing the incident.

Specifically, it:

  • Moves content about declaring an incident to the "Declare incident" page.
  • Moves content about managing a response team to a new "Response team" page.
  • Strikes content related to notifications, which is already sufficiently covered by other pages.

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

Copy link
Contributor

github-actions bot commented Aug 5, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Aug 5, 2025
@cperryk cperryk changed the title Extract off-topic sections from "Describe incident" documentation INA-7891: Extract off-topic sections from "Describe incident" documentation Aug 5, 2025
@cperryk cperryk marked this pull request as ready for review August 6, 2025 01:48
@cperryk cperryk requested a review from a team as a code owner August 6, 2025 01:48
@domalessi
Copy link
Contributor

Thanks, @cperryk ! Created DOCS-11749 for review.

@domalessi domalessi added the editorial review Waiting on a more in-depth review label Aug 6, 2025
@cperryk
Copy link
Contributor Author

cperryk commented Aug 7, 2025

Thanks @domalessi — Just for my awareness, roughly how long should I expect that review to take? (No pressure, just wondering.) And is this elevated level of review due to the fact that I have created a new page?

@domalessi
Copy link
Contributor

@cperryk The "elevated" review was just because I didn't have time to review myself during my on call session yesterday! It's a relatively small PR though, so I expect turnaround time should be within a few days. If you need this by a certain date, I can certainly flag that for my team. Let me know!

@cperryk
Copy link
Contributor Author

cperryk commented Aug 8, 2025

@domalessi Ah, I see, thanks! Not needed by a certain date. Appreciate the help!

Copy link
Contributor

@estherk15 estherk15 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 updating this @cperryk , left some formatting and link fixes. Let me know if you have questions. If this looks good, I can merge!

@cperryk
Copy link
Contributor Author

cperryk commented Aug 12, 2025

@estherk15 Thanks, merge away!

@estherk15 estherk15 merged commit 6ca682c into master Aug 12, 2025
19 of 21 checks passed
@estherk15 estherk15 deleted the christopher.kirk/update-describe-incident branch August 12, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants