Skip to content

docs: update CLI and helm reference for v2.31.0#311

Merged
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.31.0
Jul 6, 2026
Merged

docs: update CLI and helm reference for v2.31.0#311
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.31.0

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Automated update of CLI and Helm reference documentation for release v2.31.0.

@github-actions github-actions Bot requested a review from a team as a code owner July 6, 2026 15:29
@claude

claude Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Claude finished @github-actions[bot]'s task in 1m 14s —— View job


Review of PR #311 — CLI & Helm reference update for v2.31.0

  • Gather context and read changed files
  • Check new pages are in config/navigation.json
  • Check for relative links and content issues
  • Post review findings

Summary

This is a standard automated reference-docs update for v2.31.0. The changes are well-structured and the automation is working correctly. Here's what I found:

New page: client_reference/kosli_get_api-key.md

  • Front matter is present with title and description ✅
  • Page is registered in config/navigation.json
  • Uses root-relative link (/getting_started/install/...) ✅
  • No relative links ✅

CLI reference files (20 files)

  • Version bumped from v2.30.0 → v2.31.0 in overview.md
  • Example links updated to latest commit SHAs and Kosli event IDs — routine refresh ✅
  • JSON output examples refreshed with current snapshot data (indices, timestamps, fingerprints) ✅
  • New flow_name / trail_name fields added to kosli_get_attestation.md JSON output ✅
  • No relative links introduced ✅

Helm files (3 files)

  • overview.mdx: Description normalized "K8S" → "K8s" and "cronjob" → "CronJob" ✅
  • configuration.mdx: Improved permissionScope description formatting ✅
  • uninstalling.mdx: Added intro sentence before the code block ✅

Findings

Category File Detail
Suggestion helm/k8s_reporter/overview.mdx:10 "K8S" in body text wasn't updated to match the "K8s" fix in the description — inline comment posted
Suggestion helm/k8s_reporter/configuration.mdx:181 Pre-existing grammar nit ("a cluster-wide permissions", lowercase "allowed") — inline comment posted

No critical or blocking issues found. LGTM — the two inline suggestions are minor polish.

Comment thread helm/k8s_reporter/overview.mdx
Comment thread helm/k8s_reporter/configuration.mdx
@mintlify

mintlify Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Jul 6, 2026, 3:41 PM

@mbevc1 mbevc1 merged commit c0359bb into main Jul 6, 2026
6 checks passed
@mbevc1 mbevc1 deleted the reference-docs/v2.31.0 branch July 6, 2026 15:49
Sign up for free to 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.

1 participant