Skip to content

[SEC-31445] severity modifiers doc#37170

Open
BusyBeaver-42 wants to merge 9 commits into
masterfrom
romain.ageron/add-doc-for-severity-modifiers
Open

[SEC-31445] severity modifiers doc#37170
BusyBeaver-42 wants to merge 9 commits into
masterfrom
romain.ageron/add-doc-for-severity-modifiers

Conversation

@BusyBeaver-42

@BusyBeaver-42 BusyBeaver-42 commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

A new type of automation pipelines is being added (see the RFC). This PR adds the relevant documentation.

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.

AI assistance

Used for generating a first draft, proof-reading and phrasing improvements.

Additional notes

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

@BusyBeaver-42 BusyBeaver-42 marked this pull request as ready for review June 2, 2026 12:56
@BusyBeaver-42 BusyBeaver-42 requested a review from a team as a code owner June 2, 2026 12:56
@rtrieu rtrieu added the editorial review Waiting on a more in-depth review label Jun 2, 2026
@rtrieu

rtrieu commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Created DOCS-14617 for docs review.

@hugoqnc hugoqnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall looks good! One thing missing is a header for your page in the table of contents on the left:
Image

You can add it by updating config/_default/menus/main.en.yaml (example PR)

Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
Comment thread content/en/security/automation_pipelines/modify_severity.md
Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
janine-c
janine-c previously approved these changes Jun 4, 2026

@janine-c janine-c left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great! I just have a few really minor wording suggestions. If you need help applying any other edits, like modifying the main.en.yaml file Hugo mentioned, just let me know!

Comment thread content/en/security/automation_pipelines/_index.md Outdated
Comment thread content/en/security/automation_pipelines/_index.md Outdated
Comment thread content/en/security/automation_pipelines/_index.md Outdated
Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
BusyBeaver-42 and others added 2 commits June 5, 2026 14:10
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jun 5, 2026
@BusyBeaver-42 BusyBeaver-42 requested a review from janine-c July 10, 2026 15:56

@janine-c janine-c left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great! Just a couple of small writing edits here. Happy to give the final stamp once the screenshots are ready!

Comment on lines +6 to 20
- link: "/security/automation_pipelines/modify_severity"
tag: "Documentation"
text: "Severity Modifier Rules"
- link: "/security/automation_pipelines/mute"
tag: "Documentation"
text: "Mute Rules"
- link: "/security/automation_pipelines/security_inbox"
tag: "Documentation"
text: "Add to Security Inbox Rules"
- link: "/security/automation_pipelines/set_due_date"
tag: "Documentation"
text: "Set Due Date Rules"
- link: "/security/automation_pipelines/create_ticket"
tag: "Documentation"
text: "Ticket Creation Rules"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- link: "/security/automation_pipelines/mute"
tag: "Documentation"
text: "Mute Rules"
- link: "/security/automation_pipelines/security_inbox"
tag: "Documentation"
text: "Add to Security Inbox Rules"
- link: "/security/automation_pipelines/set_due_date"
tag: "Documentation"
text: "Set Due Date Rules"
- link: "/security/automation_pipelines/create_ticket"
tag: "Documentation"
text: "Ticket Creation Rules"
- link: "/security/automation_pipelines/modify_severity"
tag: "Documentation"
text: "Severity Modifier Rules"

I noticed that these links are otherwise in the same order that they appear in the sidebar, so I thought I would apply that here too for parallelism's sake. We could also consider moving the position in the sidebar, if you'd rather this new page appear higher in all these other places, of course; I just care about them matching so these links are easier to navigate.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching the ordering inconsistencies. I've reordered these, but kept Severity Modifiers first rather than moving it to match the old sidebar order.

Reason: these automation rules types are executed in order (severity modifiers -> mute -> due date -> inbox -> ticketing), and the UI already lists them in that execution order.

So I reordered the sidebar/menu instead to match the pipeline order, rather than reordering _index.md to match a sidebar order that was really just chronological-by-ship-date.

Comment thread content/en/security/automation_pipelines/_index.md
Comment thread content/en/security/automation_pipelines/_index.md
Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
Comment thread content/en/security/automation_pipelines/modify_severity.md Outdated
@janine-c janine-c dismissed their stale review July 10, 2026 17:33

Dismissing review while todos are still visible on the page, but on deck for re-review when they're replaced with screenshots 🙂

BusyBeaver-42 and others added 2 commits July 11, 2026 01:38
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
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.

4 participants