[DOCS-15364] Update Bits Remediation docs by jesshsiao · Pull Request #39189 · DataDog/documentation

jesshsiao · 2026-08-13T21:10:15Z

What does this PR do? What is the motivation?

Fixes DOCS-15364

Updates the Bits Remediation page:

Refreshes the "Automate code fixes" and "Run triage actions" copy.
Adds a "Take action on your infrastructure" section covering manual and one-click Kubernetes remediation actions, including high-level Private Action Runner and Connection prerequisites.
Adds a "Govern how Bits takes remediation action" section covering Bits Guardrails.
Adds a "Validate that issues are resolved" section.
Updates the Preview callout to match the standard "Join the Preview" pattern used on other Bits AI pages.
Adds/updates screenshots for the code fix and one-click action workflows.

Merge readiness

Ready for merge

For Datadog employees:

⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Content drafted and edited with Claude Code, based on my direction and review.

Additional notes

Add sections on infrastructure remediation actions and Bits Guardrails, refresh the code fix workflow copy, and add updated screenshots.

github-actions · 2026-08-13T21:14:12Z

Preview links (active after the `build_preview` check completes)

Modified Files

https://docs-staging.datadoghq.com/jessica.hsiao/update-bits-remediation-docs/bits_ai/bits_remediation

jesshsiao · 2026-08-13T21:14:42Z

/review

github-actions

🤖 Automated review by Claude. AI-generated; verify before acting.

Content is clear and well-structured. A few small style nits and a phrasing question inline — no blockers.

_{Reviewed f5dd8f6ea97c52ff8f26cbe47a1058227daead06 — workflow run}

github-actions · 2026-08-13T21:18:12Z

+
+Bits Investigation integrates with [Bits Code][2] to generate code fixes. Bits connects to your source code provider to create, update, and iterate on production-ready pull requests, based on existing issues detected by Datadog.
+
+Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes at your own discretion instead, disable automatic code fix generation in [Settings][3].


Style: "at your own discretion" is filler and can be dropped; the surrounding sentence already conveys the choice.

Suggested change

Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes at your own discretion instead, disable automatic code fix generation in [Settings][3].

Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes instead, disable automatic code fix generation in [Settings][3].

I'd also rephrase the beginning of this sentence to "By default, Bits Investigations automatically generates code fixes..." to make the sentence active rather than passive 🙂

github-actions · 2026-08-13T21:18:12Z

+
+Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes at your own discretion instead, disable automatic code fix generation in [Settings][3].
+
+1. [Set up Bits Code][1]. After Bits determines a code-related root cause, a suggested code fix is generated in next steps by default.


Suggestion: "in next steps" reads ambiguously — is Next Steps a UI element in the investigation? If so, capitalize it (and match on line 25) so users know where to look. If it's not a labeled section, consider rephrasing to "as a suggested next step".

github-actions · 2026-08-13T21:18:12Z

+
+## Take action on your infrastructure
+
+<div class="alert alert-danger">One-click actions are in Preview.</div>


Suggestion: The top of the page uses the {{< callout >}} shortcode for the Preview notice, but this section (and the Guardrails section on line 63) uses a raw <div class="alert alert-danger">. Consider using a consistent pattern across the page — either the shortcode or the inline HTML — so the visual treatment of Preview callouts matches.

github-actions · 2026-08-13T21:18:12Z

 - Opening Jira tickets

-Bits Investigation automatically pulls relevant context from the investigation and your connected integrations to prefill messages, incident descriptions, and ticket metadata. This reduces manual effort, ensures consistency, and accelerates response time.
+Bits automatically pulls relevant context from the investigation and your connected integrations to prefill messages, incident descriptions, and ticket metadata. This reduces manual effort, helps ensure consistency, and accelerates response time.


Style: Nice catch swapping "ensures" → "helps ensure" here — matches the Vale rule. No change needed.

janine-c

Hey Jessica, this looks awesome! I made some minor writing and structure suggestions. Some of them get a little into some tech writing inside baseball, so if you need any help implementing any fixes or want to chat over options, don't hesitate to let me know!

janine-c · 2026-08-13T21:43:57Z

+
+Bits Investigation integrates with [Bits Code][2] to generate code fixes. Bits connects to your source code provider to create, update, and iterate on production-ready pull requests, based on existing issues detected by Datadog.
+
+Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes at your own discretion instead, disable automatic code fix generation in [Settings][3].


I'd also rephrase the beginning of this sentence to "By default, Bits Investigations automatically generates code fixes..." to make the sentence active rather than passive 🙂

janine-c · 2026-08-13T22:02:13Z

+
+Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes at your own discretion instead, disable automatic code fix generation in [Settings][3].
+
+1. [Set up Bits Code][1]. After Bits determines a code-related root cause, a suggested code fix is generated in next steps by default.


It's a bit hard to tell what this list is for. It's helpful to be really clear about when information is purely conceptual (in which case, maybe this list would be to give users an idea of the sequence of events involved in using Bits Remediation) or procedural (in which case, maybe this is a list of action items for the user to accomplish something). This list is a little murky with that distinction, which can be confusing for users. I think if we made it clearer, it would be really helpful!

Adding an intro to the list like so!

To start using code fixes:

Set up Bits Code ...

...

janine-c · 2026-08-13T22:04:33Z

+1. Chat with Bits within the code session to update the suggested code fix.
+1. Create a pull request for review and merge when ready.
+
+{{< img src="bits_ai/bits_remediation/suggested_code_fix.png" alt="Bits Investigation hypothesis tree showing a root cause conclusion with a suggested code fix and other next steps" style="width:100%;" >}}


Maybe we can add an intro sentence before this image to explain exactly what it's showing?

janine-c · 2026-08-13T22:09:18Z

+- **Manual recommendations**: Copy the suggested command (for example, a `kubectl patch` command) and run it in your own CLI.
+- **One-click actions (Preview)**: Click **Run** to let Bits execute the suggested remediation action directly from the investigation context.
+
+{{< img src="bits_ai/bits_remediation/one_click_action.png" alt="A suggested remediation action with instructions to restart a deployment, a Run button, and a Verify Resolution button" style="width:100%;" >}}


I'm wondering if users might find this confusing because the Run button we're talking about is greyed out? Is there an available example we can use here where that button is usable?

The only available examples are in staging/org2, not demo org -- we didn't want anyone in demo org to be able to run these actions. I can work with engineering to make the button not grayed out in demo org but not be able to apply actions, but would it be possible to start with this screenshot?

janine-c · 2026-08-13T22:12:34Z

+- **Manual recommendations**: Copy the suggested command (for example, a `kubectl patch` command) and run it in your own CLI.
+- **One-click actions (Preview)**: Click **Run** to let Bits execute the suggested remediation action directly from the investigation context.
+
+{{< img src="bits_ai/bits_remediation/one_click_action.png" alt="A suggested remediation action with instructions to restart a deployment, a Run button, and a Verify Resolution button" style="width:100%;" >}}


Suggested change

{{< img src="bits_ai/bits_remediation/one_click_action.png" alt="A suggested remediation action with instructions to restart a deployment, a Run button, and a Verify Resolution button" style="width:100%;" >}}

{{< img src="bits_ai/bits_remediation/one_click_action.png" alt="A suggested remediation action with instructions to restart a deployment, and a Run button to restart it directly from the investigation" style="width:100%;" >}}

We don't mention the Verify Resolution button in the copy (maybe we should?), so it doesn't make sense to only mention it in the alt text. I think doing that might make a user on a screen reader worry that they missed something if they start to wonder what that button does but can't find answers in the docs.

this is related to the "Validate that issues were resolved" section on the bottom!

janine-c · 2026-08-13T22:14:38Z

+
+Guardrails require the `Guardrails Read` and `Guardrails Write` permissions. To create a guardrail:
+
+1. **Choose the actions to target**: Select one or more available actions for an integration (for example, Kubernetes) for the guardrail to target.


Can we add a step that tells the user where to go in Datadog to access these options? That will help users who come directly to this section through search 🙂

@jesshsiao Ah, sorry, I was talking about where the Bits Guardrail options are! But the location of the permissions is helpful too!

janine-c · 2026-08-13T22:16:04Z

+
+## Validate that issues are resolved
+
+Bits can verify whether a remediation action was applied successfully, and whether the original issue was resolved.


The heading here makes it sound like there's a task for users to do to validate, but then it isn't clear how a user actually does that. Maybe there was more that was supposed to be here?

Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>

Use consistent Preview callout styling, clarify the code fix steps and image intros, add guardrails permission navigation, and clarify how to validate a resolved issue.

jesshsiao · 2026-08-14T16:13:16Z

@janine-c updated content per your suggestions! let me know if you see anything else that needs to be changed :)

janine-c

Beeyootiful, thank you so much for addressing that feedback so quickly! I just have one comment I needed to clarify from last time, but overall this is looking marvellous!

janine-c · 2026-08-14T16:17:33Z

+
+Guardrails require the `Guardrails Read` and `Guardrails Write` permissions. To create a guardrail:
+
+1. **Choose the actions to target**: Select one or more available actions for an integration (for example, Kubernetes) for the guardrail to target.


@jesshsiao Ah, sorry, I was talking about where the Bits Guardrail options are! But the location of the permissions is helpful too!

Update Bits Remediation docs with new sections and screenshots

f5dd8f6

Add sections on infrastructure remediation actions and Bits Guardrails, refresh the code fix workflow copy, and add updated screenshots.

jesshsiao requested a review from a team as a code owner August 13, 2026 21:10

github-actions Bot added the Images Images are added/removed with this PR label Aug 13, 2026

github-actions Bot reviewed Aug 13, 2026

View reviewed changes

janine-c self-assigned this Aug 13, 2026

This comment has been minimized.

Sign in to view

Merge branch 'master' into jessica.hsiao/update-bits-remediation-docs

fec63b3

DataDog deleted a comment from github-actions Bot Aug 13, 2026

janine-c reviewed Aug 13, 2026

View reviewed changes

jesshsiao and others added 3 commits August 14, 2026 11:27

Update hugo/content/en/bits_ai/bits_remediation.md

3444d34

Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>

Update hugo/content/en/bits_ai/bits_remediation.md

363ed54

Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>

Address review feedback on Bits Remediation docs

5b6e07f

Use consistent Preview callout styling, clarify the code fix steps and image intros, add guardrails permission navigation, and clarify how to validate a resolved issue.

janine-c approved these changes Aug 14, 2026

View reviewed changes

jhgilbert added the astro-reorg-no-conflicts Needs manual conflict resolution after replatforming reorg label Aug 14, 2026


		Bits Investigation integrates with [Bits Code][2] to generate code fixes. Bits connects to your source code provider to create, update, and iterate on production-ready pull requests, based on existing issues detected by Datadog.

		Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes at your own discretion instead, disable automatic code fix generation in [Settings][3].


		Code fixes are automatically generated by default for investigations with code-related root causes. To manually generate code fixes at your own discretion instead, disable automatic code fix generation in [Settings][3].

		1. [Set up Bits Code][1]. After Bits determines a code-related root cause, a suggested code fix is generated in next steps by default.


		## Take action on your infrastructure

		<div class="alert alert-danger">One-click actions are in Preview.</div>

	{{< img src="bits_ai/bits_remediation/one_click_action.png" alt="A suggested remediation action with instructions to restart a deployment, a Run button, and a Verify Resolution button" style="width:100%;" >}}
	{{< img src="bits_ai/bits_remediation/one_click_action.png" alt="A suggested remediation action with instructions to restart a deployment, and a Run button to restart it directly from the investigation" style="width:100%;" >}}


		Guardrails require the `Guardrails Read` and `Guardrails Write` permissions. To create a guardrail:

		1. Choose the actions to target: Select one or more available actions for an integration (for example, Kubernetes) for the guardrail to target.


		## Validate that issues are resolved

		Bits can verify whether a remediation action was applied successfully, and whether the original issue was resolved.

Uh oh!

Conversation

jesshsiao commented Aug 13, 2026

What does this PR do? What is the motivation?

Merge readiness

For Datadog employees:

AI assistance

Additional notes

Uh oh!

github-actions Bot commented Aug 13, 2026

Preview links (active after the build_preview check completes)

Modified Files

Uh oh!

jesshsiao commented Aug 13, 2026

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

janine-c left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jesshsiao commented Aug 14, 2026

Uh oh!

janine-c left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Preview links (active after the `build_preview` check completes)