Skip to content

feat: new Kosli Capture drop-in AWS snapshotting tutorial - #337

Draft
mintlify[bot] wants to merge 20 commits into
mainfrom
mintlify/7699b463
Draft

feat: new Kosli Capture drop-in AWS snapshotting tutorial#337
mintlify[bot] wants to merge 20 commits into
mainfrom
mintlify/7699b463

Conversation

@mintlify

@mintlifymintlifyBot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Adds a new tutorial page walking through how to use kosli-dev/kosli-capture as a drop-in to start snapshotting AWS runtime environments (ECS, EKS, Lambda, tagged S3) into Kosli quickly.

Structured after tutorials/working_with_controls.mdx:

  • Beta callout up top
  • What / why intro
  • "This tutorial covers" bullet list
  • Prerequisites
  • How it works (discovery → tag filter → env name → snapshot)
  • Deploy (bootstrap + make deploy)
  • Config: naming, scope, per-type toggles, grouping, EKS namespaces
  • Runtime config sources (baked / SSM / S3)
  • EKS caveats (self-onboarding + private endpoints)
  • Verification, known limitations, "What you've accomplished"

Sourced from:

  • The kosli-capture README, config.yaml, terraform/variables.tf, and docs/architecture.md
  • The Marko/Steve conversation transcript

Added to nav under Reporting environments alongside the existing per-resource reporter tutorial.

Draft / do-not-merge as requested — this is for review with the team and a couple of customers first.


Generated by Mintlify Agent.

Requested by: marko@kosli.com via Slack
Mintlify session: slack_1778705097.340389_D0ALT8RK1CJ

@claude

claudeBot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 3m 11s —— View job


Doc review — PR #337

  • Read skill definition and CLAUDE.md
  • Read all changed files (tutorial, config reference, navigation)
  • Verify navigation entries
  • Verify internal links
  • Post review findings

Good progress since the earlier review rounds — the Diátaxis split into tutorial + reference page is exactly the right call, the internal-audience language from tooky's review has been addressed, and the tutorial now reads as a clean deploy-verify-customize flow.

tutorials/snapshotting_with_kosli_capture.mdx

CategoryFinding
ImprovementLine 70: ## 3. Bootstrap the artefacts bucket — British spelling in prose heading. Should be "artifacts" per CLAUDE.md. (The Makefile target names on line 91 like prune-artefacts are fine as-is since they match the actual CLI.) Posted as inline comment with suggestion.
SuggestionLine 96: "three places tell you Kosli Capture is doing its job" — slightly passive. Could use imperative: "check three places to confirm Kosli Capture is running". Minor; current version is clear enough.

What's working well:

  • Clean frontmatter, single short description
  • All 14 internal links are root-relative and verified to exist
  • No relative links
  • Numbered steps (1–7) provide a clear deploy flow
  • Good cross-linking to the new config reference page, including anchor links (#grouping-lambda-and-ecs, #eks-namespaces, #config-sources-at-runtime) that match actual headings
  • "What you've accomplished" closing section with next steps
  • Appropriate use of <Info> and <Tip> callouts (not overused)

kosli-capture-reference/config.mdx

CategoryFinding
No issues found

Clean reference page. Tables, YAML examples, precedence chains, and rules are well structured. Cross-links back to the tutorial. No spelling issues, no relative links.

config/navigation.json

CategoryFinding
Both new pages registered correctly
  • Tutorial: added under Tutorials > Reporting environments alongside report_aws_envs, report_k8s_envs, and report_cloud_run_envs — logical placement
  • Config reference: new Kosli Capture Reference item under the Reference tab with camera icon

Summary

CriticalImprovementSuggestion
011

The pages are in good shape. One British-spelling fix in a heading is the only actionable item. The Diátaxis split, navigation placement, link integrity, and writing style all look correct.


@mintlify

mintlifyBot commented Jul 21, 2026

Copy link
Copy Markdown
ContributorAuthor

Preview deployment for your docs. Learn more about Mintlify Previews.

ProjectStatusPreviewUpdated (UTC)
kosli🟢 ReadyView PreviewJul 21, 2026, 5:59 PM

Comment threadtutorials/snapshotting_with_kosli_capture.mdx
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
@mintlify

mintlifyBot commented Jul 21, 2026

Copy link
Copy Markdown
ContributorAuthor

Preview deployment for your docs. Learn more about Mintlify Previews.

ProjectStatusPreviewUpdated (UTC)
kosli🟡 BuildingJul 21, 2026, 5:58 PM

@mbevc1mbevc1 changed the title DO NOT MERGE: Kosli Capture drop-in AWS snapshotting tutorialfeat: Kosli Capture drop-in AWS snapshotting tutorial [DO NOT MERGE]Jul 23, 2026
@mbevc1mbevc1 changed the title feat: Kosli Capture drop-in AWS snapshotting tutorial [DO NOT MERGE]feat: new Kosli Capture drop-in AWS snapshotting tutorial [DO NOT MERGE]Jul 23, 2026
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated

@tookytooky 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.

Editorial pass focused on internal-audience language — places where the doc reads like a design review or team-facing prototype note rather than customer docs. Themes: internal vocabulary ("onboarding story", "drop-in", "the honest part", "none of it blocking"), design-rationale asides written to pre-empt internal reviewers ("so a typo cannot sweep in everything", "never silently falls back"), implementation details customers don't need ("stdlib JSON, no PyYAML", "vendor into the deploy artefact"), and comparisons against the previous Terraform iteration that customers never saw ("no Terraform, no state bucket"). All comments carry ready-to-apply suggestion blocks. Where earlier review comments cover the same line (the intro paragraph, the "honest part" heading), mine build on rather than repeat them — including an anchor fix at line 248 that the heading rename would otherwise break. The config reference tables, precedence chain, S3 opt-in rationale, and the new region/architecture constraints all read well as-is.

Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Co-authored-by: Steve Tooke <steve@took.es>
mbevc1and others added 6 commits July 23, 2026 16:18
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
mbevc1and others added 2 commits July 23, 2026 16:22
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Comment threadtutorials/snapshotting_with_kosli_capture.mdx
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Comment threadtutorials/snapshotting_with_kosli_capture.mdx Outdated
Comment threadtutorials/snapshotting_with_kosli_capture.mdx
Comment threadtutorials/snapshotting_with_kosli_capture.mdx
Comment threadkosli-capture-reference/config.mdx Outdated
Comment threadkosli-capture-reference/config.mdx Outdated
@mbevc1mbevc1 changed the title feat: new Kosli Capture drop-in AWS snapshotting tutorial [DO NOT MERGE]feat: new Kosli Capture drop-in AWS snapshotting tutorialJul 23, 2026
mbevc1and others added 2 commits July 23, 2026 16:44
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Comment threadtutorials/snapshotting_with_kosli_capture.mdx
Sign up for freeto 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

@tooky@mbevc1