[DASh 2025] Ticketing Systems topic for Security Overview #29778
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
and adding product support markdown
DOCS-10841 - added new topic for bidirectional case management
github-actions
bot
added
Architecture
ℹ️ Documentation Team ReviewNo documentation team review is required for this pull request. |
Preview links (active after the
|
cswatt
requested changes
Jun 6, 2025
There was a problem hiding this comment.
sorry for this annoying review!
I think my main concerns were:
- Clarity on what the general topic of this page is vs. what the Preview feature is. Seems to me like this is about ticketing management for security, then narrows to this specific bidirectional syncing feature for Jira and Code Security, and the latter is what's in Preview.
- "Bidirectional case management integration with Jira" is a very long string to parse as one entity. I noticed a comment in your ticket that says the feature name is "Case Management and Jira Bidirectional Syncing", so I've made a few suggestions to refer to the feature as "bidirectional syncing with Jira"
- Setup steps have kind of an awkward format
- other smaller edits/suggestions
- Also note the preprod bits logo is visible in one of the screenshots!
|
|
||
| {{< product-availability >}} | ||
|
|
||
| {{< callout btn_hidden="false" header="Join the Preview!" >}} |
There was a problem hiding this comment.
Suggested change
| {{< callout btn_hidden="false" header="Join the Preview!" >}} | |
| {{< callout btn_hidden="true" header="Join the Preview!" >}} |
|
|
||
| Open any signal in these products and use the **Create Case** button to create a case in Datadog. | ||
|
|
||
| ## Bidirectial case management with Jira |
There was a problem hiding this comment.
Suggested change
| ## Bidirectial case management with Jira | |
| ## Bidirectional ticket syncing with Jira |
I think this heading gives users a more immediate idea of what the capability is, at a glance
|
|
||
| Remediation of the finding in Datadog or defining an exception by muting the finding are the only ways to close a finding. Once the finding is remediated, its related cases and Jira tickets are closed. | ||
|
|
||
| ### Set up birdirectional case management integration with Jira |
There was a problem hiding this comment.
Suggested change
| ### Set up birdirectional case management integration with Jira | |
| ### Set up bidirectional syncing |
|
|
||
| ### Set up birdirectional case management integration with Jira | ||
|
|
||
| The following steps set up birdirectional case management integration with Jira and use Code Security vulnerabilites to verify that setup is successful. |
There was a problem hiding this comment.
Suggested change
| The following steps set up birdirectional case management integration with Jira and use Code Security vulnerabilites to verify that setup is successful. | |
| The following steps set up bidirectional syncing with Jira and use Code Security vulnerabilities to verify that setup is successful. |
| The following steps set up birdirectional case management integration with Jira and use Code Security vulnerabilites to verify that setup is successful. | ||
|
|
||
| 1. Set up the following prerequisites in your Datadog account, or verify that they are set up already. The prerequisites are listed in their setup order. | ||
| 1. A [Datadog Jira integration][2]. |
There was a problem hiding this comment.
Suggested change
| 1. A [Datadog Jira integration][2]. | |
| 1. The [Datadog Jira integration][2]. |
there's only one!
|
|
||
| Here's an example from a Static Code (SAST) signal: | ||
|
|
||
| {{< img src="security/bidir-jira-existing.png" alt="signal with existing Jira ticket" responsive="true" style="width:100%;">}} |
There was a problem hiding this comment.
Suggested change
| {{< img src="security/bidir-jira-existing.png" alt="signal with existing Jira ticket" responsive="true" style="width:100%;">}} | |
| {{< img src="security/bidir-jira-existing.png" alt="signal with existing Jira ticket: in the Next Steps section, under Ticket Created, a pill with the Jira logo and text 'CJT-16'" responsive="true" style="width:100%;">}} |
|
|
||
| Hover over the Jira ticket to see its details. | ||
|
|
||
| {{< img src="security/bidir-jira-existing-hover.png" alt="signal with existing Jira ticket" responsive="true" style="width:100%;">}} |
There was a problem hiding this comment.
Suggested change
| {{< img src="security/bidir-jira-existing-hover.png" alt="signal with existing Jira ticket" responsive="true" style="width:100%;">}} | |
| {{< img src="security/bidir-jira-existing-hover.png" alt="Mouseover state for pill in previous image. Modal with Jira ticket details." responsive="true" style="width:100%;">}} |
|
|
||
| In **Datadog Associated Case**, the related Datadog case is provided. Click the case name to open it in [Case Management][1]. | ||
|
|
||
| Deleting a case does not delete related Jira tickets, but deleting a case project deattaches all tickets from related signals. |
There was a problem hiding this comment.
Suggested change
| Deleting a case does not delete related Jira tickets, but deleting a case project deattaches all tickets from related signals. | |
| Deleting a case does not delete related Jira tickets, but deleting a case project detaches all tickets from related signals. |
|
|
||
| Deleting a case does not delete related Jira tickets, but deleting a case project deattaches all tickets from related signals. | ||
|
|
||
| ### Bidirectional case management facets |
There was a problem hiding this comment.
Suggested change
| ### Bidirectional case management facets | |
| ### Bidirectional Case Management facets |
|
|
||
| ### Bidirectional case management facets | ||
|
|
||
| There are several case management facets, including: |
There was a problem hiding this comment.
what entities are these facets attached to? the vulnerabilities, the case management projects, etc.?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doc ticket: DOCS-10841
Editing ticket: DOCS-11099
What does this PR do? What is the motivation?
Merge instructions
To be merged the day before DASH.