fix: switch cyber-dojo tutorials to kosli search#265
Conversation
The "tracing a production incident" and "from commit to production" tutorials used 'kosli get artifact <flow>@<short-sha>' examples that no longer work: the cyber-dojo flows they reference (creator, runner) were renamed when archived, and the get-artifact endpoint rejects short fingerprints. 'kosli search' resolves short fingerprints and commit SHAs org-wide, including archived flows, so the walkthroughs work again. Refresh the documented command output to match what the CLI (v2.26.0) prints against prod today, and fix the artifact deep link that 404'd since the flow rename. Addresses kosli-dev/server#4937. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Claude finished @AlexKantor87's task in 1m 28s —— View job PR Review: Switch cyber-dojo tutorials to
|
| # | File | Lines | Issue |
|---|---|---|---|
| 1 | following_a_git_commit_to_runtime_environments.md |
89–91 | The <Info> says "cyber-dojo's flows have since been reorganized" which could be read broadly; narrowing to "the original runner flow" would be more precise. |
| 2 | following_a_git_commit_to_runtime_environments.md |
112 | Minor column-alignment inconsistency in the get snapshot output block (RUNNING_SINCE/REPLICAS spacing differs between rows). Likely just CLI output behavior — worth a glance. |
Convention compliance
- Links: All internal links are root-relative. All targets (
/getting_started/install,/getting_started/flows,/client_reference/kosli_snapshot_k8s,/tutorials/querying_kosli) resolve to existing files. - Frontmatter: Both files have
titleanddescription. No changes needed. - Navigation: No new pages — no
config/navigation.jsonupdate required. - Writing style: Active voice, imperative mood, "Kosli" (not "the Kosli platform"), American spelling. All good.
- Components:
<Info>,<Tooltip>,<Frame>used appropriately and sparingly. - No relative links found.
Overall assessment
Ship it. The tutorials now work against prod, the explanatory callouts handle the archived-flow naming gracefully, and the out-of-scope decision for querying_kosli.md is well-reasoned in the PR description.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
@JonJagger flagging one thing before this merges. The The new In practice it's cosmetic: the org being public means reads work regardless. I verified an unauthenticated GET on The real fix sits on the cyber-dojo side rather than in the docs: flipping the I'm holding the merge until then. Everything else in the PR stands. |
Why
Two tutorials walk users through
kosli get artifact <flow>@<short-sha>against the public cyber-dojo org, and both commands now fail (kosli-dev/server#4937):creator,runner) were renamed to<name>-archived-at-<timestamp>when archived in early 2024, so the flow name no longer resolves.^[a-f0-9]{64}$validation), with a misleading error message.Accepting short fingerprints (kosli-dev/server#5474) is worth fixing server-side, but it won't repair these tutorials on its own because of the flow renames.
kosli searchresolves short fingerprints and commit SHAs org-wide, including archived flows, so it's the right tool for both walkthroughs.What changed
tutorials/tracing_a_production_incident_back_to_git_commits.md:kosli get artifact creator@860ad17becomeskosli search 860ad17.tutorials/following_a_git_commit_to_runtime_environments.md:kosli get artifact runner:16d9990becomeskosli search 16d9990.list flowstable, the COMPLIANCE column inget snapshot, andInstancesindiff snapshots.<Info>in each tutorial explaining the-archived-at-<timestamp>names. The rename-on-archive behaviour itself now has its own issue: kosli-dev/server#5879.Deliberately out of scope:
tutorials/querying_kosli.mdhas the same problem throughout (its whole walkthrough is built on the archivedcreatorflow, includingkosli list artifacts --flow creator), and its "Get artifact" section exists to document theflow@shasyntax that's under discussion in kosli-dev/server#5476. It deserves its own pass once kosli-dev/server#5474 lands.Verification
KOSLI_ORG=cyber-dojo, read-only token); the output blocks are verbatim captures.mint broken-linkspasses.🤖 Generated with Claude Code