Skip to content

docs(features): merge slo-operations into canonical slo guide - #842

Merged
blue4209211 merged 6 commits into
mainfrom
codex/merge-slo-docs
Sep 6, 2026
Merged

docs(features): merge slo-operations into canonical slo guide#842
blue4209211 merged 6 commits into
mainfrom
codex/merge-slo-docs

Conversation

@blue4209211

Copy link
Copy Markdown
Contributor

Summary

Consolidates the disjoint slo.md and slo-operations.md pages into a single, cohesive, production-grade guide under doc-server/docs/features/slo.md.

Changes Included

  1. Canonical Guide (doc-server/docs/features/slo.md):

    • Merged high-level UI details (screenshot slo-list.png, Loom walkthrough video, and navigation under Cluster Details → Monitoring → SLO) with the technical SRE operational guide.
    • Core concepts: SLI, SLO, Error Budget, and Burn Rates with Mermaid flow diagram.
    • Step-by-step creation flow in NudgeBee.
    • Defining SLIs with ratio-based PromQL queries (good vs. total requests) and threshold-based latency queries.
    • Multi-window multi-burn-rate alerting matrix with integration to notification channels and Autopilot.
    • Interactive NuBi prompts.
  2. Removed Redundant Page:

    • Deleted doc-server/docs/features/slo-operations.md.
  3. Redirect & Reference Updates:

    • Added client redirect in doc-server/docusaurus.config.js:
      { from: '/docs/features/slo-operations', to: '/docs/features/slo' }
    • Updated doc-server/docs/features/index.md to point directly to ./slo.md.

Verification

  • Ran npm run build in doc-server: static pages built cleanly with 0 broken links and 0 warnings.

@blue4209211

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request consolidates the SLO documentation by merging 'slo-operations.md' into 'slo.md', updating references, and adding a redirect in 'docusaurus.config.js'. The review feedback suggests updating the embedded Loom video iframe attributes to use React's camelCase convention (such as 'frameBorder' and 'allowFullScreen') and removing deprecated attributes to prevent Docusaurus MDX rendering warnings.

Comment thread doc-server/docs/features/slo.md Outdated

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request consolidates the SLO documentation by merging the contents of slo-operations.md into slo.md, updating the index links, and adding a redirect in docusaurus.config.js. Feedback is provided regarding the use of standard HTML attributes in an iframe inside slo.md; these should be converted to camelCase to comply with MDX (React-based Markdown) requirements and prevent console warnings.

Comment thread doc-server/docs/features/slo.md Outdated
@blue4209211

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request consolidates the SLO documentation by merging slo-operations.md into slo.md, updating links, and adding a redirect in docusaurus.config.js. The review feedback suggests removing the redundant title field from the front matter of slo.md to prevent duplicate <h1> headings from rendering in Docusaurus.

Comment thread doc-server/docs/features/slo.md
@blue4209211

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request consolidates and updates the documentation for Service Level Objectives (SLOs) and Error Budgets by merging the contents of 'slo-operations.md' into 'slo.md', updating links, and adding a redirect in 'docusaurus.config.js'. The feedback suggests correcting a description in 'slo.md' to accurately describe a PromQL query as calculating a latency percentage rather than a histogram quantile.

Comment thread doc-server/docs/features/slo.md Outdated
@blue4209211

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request consolidates and expands the documentation for Service Level Objectives (SLOs) and Error Budgets by merging the content of slo-operations.md into slo.md, updating internal links, and setting up a redirect in docusaurus.config.js. Feedback was provided to improve the PromQL regular expression used in the SLI example to be more precise and robust.

Comment thread doc-server/docs/features/slo.md Outdated
@blue4209211

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request consolidates the SLO documentation by merging the contents of slo-operations.md into slo.md, updating internal links, and adding a redirect rule in docusaurus.config.js. The review feedback recommends a minor improvement to replace the obsolete frameBorder attribute on the Loom walkthrough <iframe> with a CSS border: 0 style property to adhere to modern standards.

Comment thread doc-server/docs/features/slo.md Outdated
@blue4209211

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request consolidates the SLO documentation by merging the contents of slo-operations.md into slo.md, updating the index page links, and setting up a Docusaurus redirect from /docs/features/slo-operations to /docs/features/slo. The updated documentation provides a comprehensive guide on SLOs, Error Budgets, SLIs, and multi-window burn-rate alerting. I have no feedback to provide as there are no review comments.

@blue4209211
blue4209211 merged commit 8dcb096 into main Sep 6, 2026
4 checks passed
@blue4209211
blue4209211 deleted the codex/merge-slo-docs branch September 6, 2026 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants