docs(features): merge slo-operations into canonical slo guide - #842
Conversation
|
@gemini-code-assist review |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
@gemini-code-assist review |
There was a problem hiding this comment.
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.
|
@gemini-code-assist review |
There was a problem hiding this comment.
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.
|
@gemini-code-assist review |
There was a problem hiding this comment.
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.
|
@gemini-code-assist review |
There was a problem hiding this comment.
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.
|
@gemini-code-assist review |
There was a problem hiding this comment.
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.
afa8ba1 to
accfb45
Compare
Summary
Consolidates the disjoint
slo.mdandslo-operations.mdpages into a single, cohesive, production-grade guide underdoc-server/docs/features/slo.md.Changes Included
Canonical Guide (
doc-server/docs/features/slo.md):slo-list.png, Loom walkthrough video, and navigation under Cluster Details → Monitoring → SLO) with the technical SRE operational guide.Removed Redundant Page:
doc-server/docs/features/slo-operations.md.Redirect & Reference Updates:
doc-server/docusaurus.config.js:{ from: '/docs/features/slo-operations', to: '/docs/features/slo' }doc-server/docs/features/index.mdto point directly to./slo.md.Verification
npm run buildindoc-server: static pages built cleanly with 0 broken links and 0 warnings.