docs(canary-checker): remove removed check docs#518
Open
adityathebe wants to merge 2 commits into
Open
Conversation
Containerd, Docker, Helm, Git protocol, namespace, and pod checks now route through the removed checker in canary-checker. Remove their stale reference pages and spec table rows, and update homepage and metrics references so docs no longer link to removed check types.
✅ Deploy Preview for canarychecker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughRemoves obsolete canary-checker reference pages (git, pod, containerd, helm) and their corresponding table entries, updates infrastructure/integration examples in Home.jsx and Integrations.jsx, and applies formatting fixes to example tables and YAML snippets across canary-checker and mission-control docs. ChangesDocumentation and component updates
Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Apply the repository Prettier formatting expected by the CI lint workflow.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@canary-checker/docs/scripting/_functions.md`:
- Around line 42-46: The documentation table entries for regexp.Find,
regexp.FindAll, regexp.Match, regexp.Replace, and regexp.Split have lost spaces
around inline code spans, making the descriptions hard to read. Update the
affected descriptions in _functions.md to restore normal spacing around terms
like input, expression, and true, keeping the existing wording intact while
improving readability.
- Around line 3-12: The function table in the scripting docs has an inconsistent
column count between the header/separator and the body rows, which will break
rendering. Update the table under the functions section so every row uses the
same number of columns as the header, and adjust the header separator to match;
use the existing `len`, `index`, `and`/`or`/`not`/comparison operators,
`print`/`printf`/`println`, `ternary`, `humanizeBytes`, `humanizeTime`, and
`humanizeDuration` entries as the anchor for the fix.
In `@mission-control/docs/guide/config-db/scrapers/azure.md`:
- Line 86: The markdown table row for the Azure resource mapping includes an
extra trailing plus sign that is being parsed as an additional cell and breaks
the table layout. Update the table entry in the Azure scraper config doc by
removing the trailing character from that row, keeping the row aligned with the
surrounding table format.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9a69bb6e-50e6-4836-92dd-ae135fcf4df6
📒 Files selected for processing (16)
canary-checker/docs/concepts/metrics.mdxcanary-checker/docs/concepts/secret-management.mdcanary-checker/docs/reference/1-git.mdxcanary-checker/docs/reference/1-pod.mdxcanary-checker/docs/reference/3-containerd.mdxcanary-checker/docs/reference/3-helm.mdxcanary-checker/docs/reference/_canary-spec.mdxcanary-checker/docs/scripting/_functions.mdcommon/src/components/Home.jsxcommon/src/components/Integrations.jsxmission-control/docs/guide/config-db/scrapers/azure.mdmission-control/docs/guide/notifications/channels/index.mdmission-control/docs/guide/views/concepts/templating.mdmission-control/docs/guide/views/queries/changes.mdmission-control/docs/integrations/kubernetes/playbooks.mdmission-control/docs/reference/canary-checker/index.mdx
💤 Files with no reviewable changes (7)
- canary-checker/docs/reference/3-helm.mdx
- canary-checker/docs/reference/1-git.mdx
- canary-checker/docs/reference/1-pod.mdx
- canary-checker/docs/reference/3-containerd.mdx
- common/src/components/Integrations.jsx
- canary-checker/docs/reference/_canary-spec.mdx
- mission-control/docs/reference/canary-checker/index.mdx
Comment on lines
+3
to
+12
| | Function | Description | Lang | | ||
| | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------ | ------------ | | ||
| | `len` | | `gotemplate` | | ||
| | `index` | Returns the referenced element of an array/slice, string, or map | `gotemplate` | | ||
| | `and` (&&), `or` ( | | ), `not` (!), eq`(==), `lt` (<)`le`, (<=) `gt`(>),`ge` (>=) | Equality operators | `gotemplate` | | ||
| | `print`, `printf`, `println` | Aliases for Go’s [`fmt.Print`](https://golang.org/pkg/fmt/#Print), [`fmt.Printf`](https://golang.org/pkg/fmt/#Printf), and [`fmt.Println`](https://golang.org/pkg/fmt/#Println) functions | | | ||
| | `len` | | `gotemplate` | | ||
| | `index` | Returns the referenced element of an array/slice, string, or map | `gotemplate` | | ||
| | `and` (&&), `or` ( | | ), `not` (!), eq`(==), `lt` (<)`le`, (<=) `gt`(>),`ge`(>=) | Equality operators |`gotemplate`| | ||
| |`print`, `printf`, `println` | Aliases for Go’s [`fmt.Print`](https://golang.org/pkg/fmt/#Print), [`fmt.Printf`](https://golang.org/pkg/fmt/#Printf), and [`fmt.Println`](https://golang.org/pkg/fmt/#Println) functions | | | ||
| | [ternary](https://docs.gomplate.ca/functions/test/#testternary) | Returns one of two values depending on whether the third is true. | | | ||
| | `humanizeBytes` | Returns a human readable value for bytes .e.g. `1mb` | | | ||
| | `humanizeTime` | | | | ||
| | `humanizeDuration` | | | | ||
| | `humanizeBytes` | Returns a human readable value for bytes .e.g.`1mb` | | | ||
| |`humanizeTime` | | | | ||
| |`humanizeDuration` | | | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep the function table column count consistent.
The rewritten header no longer matches the separator/body, so this section will render as a malformed table.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@canary-checker/docs/scripting/_functions.md` around lines 3 - 12, The
function table in the scripting docs has an inconsistent column count between
the header/separator and the body rows, which will break rendering. Update the
table under the functions section so every row uses the same number of columns
as the header, and adjust the header separator to match; use the existing `len`,
`index`, `and`/`or`/`not`/comparison operators, `print`/`printf`/`println`,
`ternary`, `humanizeBytes`, `humanizeTime`, and `humanizeDuration` entries as
the anchor for the fix.
Comment on lines
+42
to
+46
| | [regexp.Find](https://docs.gomplate.ca/functions/regexp/#regexpfind) | Returns a string holding the text of the leftmost match in `input`of the regular expression`expression`. | | | ||
| | [regexp.FindAll](https://docs.gomplate.ca/functions/regexp/#regexpfindall) | Returns a list of all successive matches of the regular expression. | | | ||
| | [regexp.Match](https://docs.gomplate.ca/functions/regexp/#regexpmatch) | Returns `true` if a given regular expression matches a given input. | | | ||
| | [regexp.Match](https://docs.gomplate.ca/functions/regexp/#regexpmatch) | Returns `true`if a given regular expression matches a given input. | | | ||
| | [regexp.Replace](https://docs.gomplate.ca/functions/regexp/#regexpreplace) | Replaces matches of a regular expression with the replacement string. | | | ||
| | [regexp.Split](https://docs.gomplate.ca/functions/regexp/#regexpsplit) | Splits `input` into sub-strings, separated by the expression. | | | ||
| | [regexp.Split](https://docs.gomplate.ca/functions/regexp/#regexpsplit) | Splits`input` into sub-strings, separated by the expression. | | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Restore the missing spacing in the descriptions.
These edits collapse words around the inline code spans, which hurts readability.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@canary-checker/docs/scripting/_functions.md` around lines 42 - 46, The
documentation table entries for regexp.Find, regexp.FindAll, regexp.Match,
regexp.Replace, and regexp.Split have lost spaces around inline code spans,
making the descriptions hard to read. Update the affected descriptions in
_functions.md to restore normal spacing around terms like input, expression, and
true, keeping the existing wording intact while improving readability.
| | microsoft.network/privatednszones | PrivateDNSZone | | ||
| | microsoft.network/trafficmanagerprofiles | TrafficManagerProfile | | ||
| | microsoft.network/networksecuritygroups | SecurityGroup | | ||
| | microsoft.network/publicipaddresses | PublicIPAddress | + | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Drop the trailing + from the table row.
That character becomes a literal extra cell and breaks the markdown table layout.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@mission-control/docs/guide/config-db/scrapers/azure.md` at line 86, The
markdown table row for the Azure resource mapping includes an extra trailing
plus sign that is being parsed as an additional cell and breaks the table
layout. Update the table entry in the Azure scraper config doc by removing the
trailing character from that row, keeping the row aligned with the surrounding
table format.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Containerd, Docker, Helm, Git protocol, namespace, and pod checks now route through the removed checker in canary-checker.
Remove the stale reference pages and spec table rows for those check types. Update homepage integration links and the metrics docs so the docs no longer point to removed check references.
Summary by CodeRabbit
Documentation
Content Updates