Skip to content

[SEC-31367] Document Ticket Creation Rules for Automation Pipelines#36851

Merged
hugoqnc merged 6 commits into
masterfrom
hugo.queinnec/ticket-creation-rules
May 22, 2026
Merged

[SEC-31367] Document Ticket Creation Rules for Automation Pipelines#36851
hugoqnc merged 6 commits into
masterfrom
hugo.queinnec/ticket-creation-rules

Conversation

@hugoqnc
Copy link
Copy Markdown
Contributor

@hugoqnc hugoqnc commented May 20, 2026

What does this PR do? What is the motivation?

Adds documentation for the new Ticket Creation Rules feature in Automation Pipelines (SEC-27479).

  • New page content/en/security/automation_pipelines/create_ticket.md documenting how to create, test, and manage ticket creation rules for Jira and Case Management
  • Two screenshots added: the lightning bolt indicator on automatically created tickets, and the broken rule error state
  • Updated _index.md to add the new page to further_reading and add a use case section for ticket creation
  • Updated side nav menu to include the new page

Preview

https://docs-staging.datadoghq.com/hugo.queinnec/ticket-creation-rules/security/automation_pipelines/create_ticket/

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@hugoqnc hugoqnc requested a review from a team as a code owner May 20, 2026 13:32
@github-actions github-actions Bot added the Images Images are added/removed with this PR label May 20, 2026
@hugoqnc hugoqnc marked this pull request as draft May 20, 2026 14:06
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label May 20, 2026
@hugoqnc hugoqnc changed the title Document Ticket Creation Rules for Automation Pipelines [SEC-31367] Document Ticket Creation Rules for Automation Pipelines May 20, 2026
Comment thread content/en/security/automation_pipelines/_index.md Outdated
@datadog-prod-us1-6

This comment has been minimized.

Copy link
Copy Markdown
Contributor

@alex147 alex147 left a comment

Choose a reason for hiding this comment

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

LGTM, just a single sentence that I find a bit confusing.

Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
Copy link
Copy Markdown
Contributor

@janine-c janine-c left a comment

Choose a reason for hiding this comment

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

Looks great! I made some suggestions about things like writing style and content ordering, and in one case some additional steps we might want to add, but nothing that's a big blocker 🙂 Feel free to ping me for any questions, any help implementing any of this, or for any additional review!

Comment thread content/en/security/automation_pipelines/_index.md Outdated
Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated

Tickets created by a rule are marked with a lightning bolt indicator in the findings side panel and explorer views. Hovering over the indicator shows the automation rule responsible for the ticket and provides a link to the rule.

## Rule matching order
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.

If you wanted to, I think you could put these sections as subsections in the intro. I think it's helpful for users when they're deciding if they want to use a feature to get the nuance of how it works, and it helps if they can expect conceptual information to appear in one place in the doc. It's not terrible to have it at the end, but it does feel a little more tacked on than the "this is what this thing does!" expectation users already have about overviews.

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 the suggestion, I tried restructuring with those subsections in the intro, but I'm not fully convinced it works well. Those are fairly fine-grained implementation details that most users won't need to read before getting started. The other automation pipeline pages also follow the pattern of putting procedural steps first, which keeps things consistent. I've also kept a link from the rate limit step in the creation flow to the dedicated section, so users who need the detail can jump to it. Happy to revisit if you feel strongly, but I'd lean toward keeping the current structure.

Comment thread content/en/security/automation_pipelines/create_ticket.md Outdated
hugoqnc and others added 3 commits May 21, 2026 10:43
@hugoqnc hugoqnc marked this pull request as ready for review May 22, 2026 09:28
@hugoqnc hugoqnc merged commit 05516e5 into master May 22, 2026
16 checks passed
@hugoqnc hugoqnc deleted the hugo.queinnec/ticket-creation-rules branch May 22, 2026 09:28
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 Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants