chore: update canary-checker source references #467
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for canarychecker canceled.
|
WalkthroughStandardizes documentation source references across canary-checker and mission-control modules by removing line numbers from source anchors (e.g., Changes
Sequence Diagram(s)(omitted — changes are documentation/schema alignments and submodule pointer updates; no new multi-component control flow introduced) Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
mission-control/docs/guide/config-db/scrapers/clickhouse.mdx (1)
210-230: Schema and example field mismatches require correction.The documented schemas and examples have inconsistent field names:
- AWSS3: Example uses
connection: connection://aws(line 192), but the schema only documentsbucket,path,endpoint,accessKey,secretKey, andregion.- AzureBlobStorage: Example uses
collectionName(line 214) while the schema documentscollection(required field). Example also usesconnectionString(lines 215-219), which is not in the schema.Update either the schema documentation (lines 60-141) or the examples (lines 180-240) to match, or provide documentation for the missing
connectionandconnectionStringfields if they are valid configuration options.
🤖 Fix all issues with AI agents
In @.claude/skills/update-source-references/SKILL.md:
- Line 1: Several MDX/MD files under `@docs/canary-checker/` and
`@docs/mission-control/` that contain HTML source comments like "<!-- Source: ...
-->" are missing a top-level H1 and trigger markdownlint MD041; open each file
containing that "<!-- Source:" pattern and insert a single top-level heading (a
line starting with "# ") as the very first line before any body text, then save
and run make fmt and make lint to verify/style the change.
In `@canary-checker/docs/reference/1-git.mdx`:
- Around line 20-21: Update the description for the githubToken entry so the
product name is capitalized correctly: change "Github Personal Access Token" to
"GitHub Personal Access Token" in the object with field "githubToken" to ensure
consistent capitalization across docs.
In `@canary-checker/docs/reference/1-http.mdx`:
- Line 33: Update the "Template Body Variables" section to use the renamed field
env: replace any occurrences of envVars with env and change the placeholder
{fields from []envVars} to {fields from []env} so the documentation consistently
references the new field name (ensure strings and example references that
mention envVars are updated to env as well).
In `@canary-checker/docs/reference/jmeter.mdx`:
- Line 21: The docs table entry for responseDuration is incorrect: update the
Scheme column for `responseDuration` from `*string*` to `*int*` to match the Go
struct (responseDuration) type; locate the `responseDuration` row in
canary-checker/docs/reference/jmeter.mdx and replace the type token accordingly
so the documentation aligns with the code.
🧹 Nitpick comments (4)
mission-control/docs/guide/mcp/client-setup.mdx (1)
315-387: Consider removing duplicate content.The "Troubleshooting" and "Next Steps" sections appear twice in this file (lines 315-350 and lines 352-387). While this duplication wasn't introduced in this PR, it would be good to clean up the duplicates in a follow-up to improve documentation quality.
mission-control/docs/guide/config-db/scrapers/azure.md (1)
37-37: Use second person or noun phrase for consistency.The description uses third person ("Specifies"), which is inconsistent with the Google Style Guide's preference for second person or noun phrases. Other entries in this table use either imperatives ("Specify...") or noun phrases.
✏️ Suggested alternatives
-| `exclusions` | Specifies the Azure resources to exclude | [`Exclusion`](`#exclusion`) | | +| `exclusions` | Azure resources to exclude from scraping | [`Exclusion`](`#exclusion`) | |Alternative with imperative form:
-| `exclusions` | Specifies the Azure resources to exclude | [`Exclusion`](`#exclusion`) | | +| `exclusions` | Exclude Azure resources from scraping | [`Exclusion`](`#exclusion`) | |Based on coding guidelines, documentation should follow Google style using second person, active voice, and present tense.
mission-control/docs/guide/config-db/scrapers/trivy.mdx (1)
55-60: Pre-existing issues in this file.While not introduced by this PR, there are a couple of issues worth noting:
Duplicate import statement: Line 60 duplicates the import from line 8 (
import { Trivy } from "@flanksource/icons/mi"). This appears misplaced after the table content.Table formatting artifacts: Lines 55-59 have trailing
| sin the last column which appears to be a formatting error.Consider addressing these in a follow-up cleanup.
canary-checker/docs/reference/1-mongo.mdx (1)
13-14: Pre-existing: YAML title mismatch.The code block title says
icmp.yamlbut this is the MongoDB check documentation. Consider updating tomongo.yamlor similar in a follow-up.
| @@ -0,0 +1,22 @@ | |||
| For all mdx/md files in @docs/canary-checker/ and @docs/mission-control/ that have `<!-- Source: ... -->` comments pointing to Go source files: | |||
There was a problem hiding this comment.
Add a top-level heading as the first line.
Markdownlint MD041 expects the first line to be an H1; start with a # heading before the body text.
As per coding guidelines, run make fmt/make lint to catch this.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In @.claude/skills/update-source-references/SKILL.md at line 1, Several MDX/MD
files under `@docs/canary-checker/` and `@docs/mission-control/` that contain HTML
source comments like "<!-- Source: ... -->" are missing a top-level H1 and
trigger markdownlint MD041; open each file containing that "<!-- Source:"
pattern and insert a single top-level heading (a line starting with "# ") as the
very first line before any body text, then save and run make fmt and make lint
to verify/style the change.
| {field: "connection", description: "Connection name for GitHub credentials", scheme: 'string'}, | ||
| {field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar'}, |
There was a problem hiding this comment.
Capitalize “GitHub” consistently in the token description.
Minor doc polish to match the official product name.
🔧 Suggested edit
- {field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar'},
+ {field: "githubToken", description: "GitHub Personal Access Token", scheme: 'EnvVar'},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {field: "connection", description: "Connection name for GitHub credentials", scheme: 'string'}, | |
| {field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar'}, | |
| {field: "connection", description: "Connection name for GitHub credentials", scheme: 'string'}, | |
| {field: "githubToken", description: "GitHub Personal Access Token", scheme: 'EnvVar'}, |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: The official name of this software platform is spelled with a capital “H”.
Context: ... {field: "githubToken", description: "Github Personal Access Token", scheme: 'EnvVar...
(GITHUB)
🤖 Prompt for AI Agents
In `@canary-checker/docs/reference/1-git.mdx` around lines 20 - 21, Update the
description for the githubToken entry so the product name is capitalized
correctly: change "Github Personal Access Token" to "GitHub Personal Access
Token" in the object with field "githubToken" to ensure consistent
capitalization across docs.
| {field: "thresholdMillis", description: "Maximum duration in milliseconds for the HTTP request. It will fail the check if it takes longer", default: 5000, scheme: "int"}, | ||
| {field: "maxSSLExpiry", description: <>Maximum number of days until the SSL Certificate expires<br/>Equivalent to <code>test.expr: sslAge < Age("7d")</code></>, scheme: "int"}, | ||
| {field: "envVars", description: "Setup environment variables that are accessible while templating", scheme: "[]EnvVar"}, | ||
| {field: "env", description: "Environment variables that are accessible while templating", scheme: "[]EnvVar"}, |
There was a problem hiding this comment.
Update the Template Body Variables section to use env.
You rename the field to env, but the later section still says envVars and {fields from []envVars}. Make that section match the new field name to avoid confusion.
🤖 Prompt for AI Agents
In `@canary-checker/docs/reference/1-http.mdx` at line 33, Update the "Template
Body Variables" section to use the renamed field env: replace any occurrences of
envVars with env and change the placeholder {fields from []envVars} to {fields
from []env} so the documentation consistently references the new field name
(ensure strings and example references that mention envVars are updated to env
as well).
| | **`jmx`** | Jmx defines the ConfigMap or Secret reference to get the JMX test plan | <CommonLink to="authentication">*EnvVar*</CommonLink> | Yes | | ||
| | `properties` | Properties defines the local JMeter properties | *\[\]string* | | | ||
| | `responseDuration` | duration under which the all the test should pass | *int* | | | ||
| | `responseDuration` | Duration under which all the tests should pass | *string* | | |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
rg -n --type=go 'type\s+JmeterCheck' -A 30Repository: flanksource/docs
Length of output: 42
🏁 Script executed:
rg -n 'JmeterCheck' -A 5Repository: flanksource/docs
Length of output: 1598
🏁 Script executed:
git ls-files | grep -E '\.go$' | head -20Repository: flanksource/docs
Length of output: 235
🏁 Script executed:
cat -n canary-checker/docs/reference/jmeter.mdx | head -40Repository: flanksource/docs
Length of output: 2444
🌐 Web query:
canary-checker JmeterCheck responseDuration field type site:github.com
💡 Result:
In Canary Checker’s JmeterCheck spec, the responseDuration field is typed as an integer (int) in the published schema/docs. [1]
Source(s):
[1] (canarychecker.io)
Citations:
🌐 Web query:
site:github.com/flanksource JmeterCheck responseDuration type:code
💡 Result:
In Flanksource Canary Checker, the JMeter check (spec.jmeter[]) has a field:
responseDuration:int— “duration under which the all the test should pass” (i.e., a threshold for acceptable test duration). [1]
Source: JMeter check reference docs. [1]
🌐 Web query:
site:github.com/flanksource/canary-checker "type JmeterCheck struct" responseDuration
💡 Result:
In canary-checker’s JMeter check spec, responseDuration is documented as an integer field: “duration under which the all the test should pass” (i.e., a threshold duration for the JMeter run to be considered successful). [1]
Update responseDuration type from string to int.
The field is typed as int in the Go struct, not string. Line 21 should show *int* in the Scheme column.
🤖 Prompt for AI Agents
In `@canary-checker/docs/reference/jmeter.mdx` at line 21, The docs table entry
for responseDuration is incorrect: update the Scheme column for
`responseDuration` from `*string*` to `*int*` to match the Go struct
(responseDuration) type; locate the `responseDuration` row in
canary-checker/docs/reference/jmeter.mdx and replace the type token accordingly
so the documentation aligns with the code.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.