Skip to content

docs: break k8s_reporter helm chart page into subpages#306

Merged
mbevc1 merged 2 commits into
mainfrom
mintlify/4a950f8f
Jul 3, 2026
Merged

docs: break k8s_reporter helm chart page into subpages#306
mbevc1 merged 2 commits into
mainfrom
mintlify/4a950f8f

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Splits the single helm/k8s_reporter page into a nested section with the following subpages:

  • Overview
  • Prerequisites
  • Installing the chart
  • Upgrading the chart
  • Uninstalling the chart
  • Running behind a TLS-inspecting proxy
  • Running on EKS with Karpenter
  • Configuration reference

Also:

  • Adds a redirect from /helm/k8s_reporter/helm/k8s_reporter/overview.
  • Updates the Karpenter deep-link in tutorials/report_k8s_envs to point to the new dedicated page.
  • Nests the new pages under a "Kubernetes Reporter" group in the Helm Charts sidebar.

Requested in Slack.


Generated by Mintlify Agent.

Requested by: marko@kosli.com via Slack
Mintlify session: slack_1783095667.392089_C0AJTQ5633K

@mintlify mintlify Bot requested a review from a team as a code owner July 3, 2026 16:24
@claude

claude Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mintlify[bot]'s task in 1m 25s —— View job


Review of PR #306

  • Read CLAUDE.md and doc-review skill
  • Analyze PR diff and changed files
  • Check navigation config for new pages
  • Check for relative links
  • Review content quality and conventions
  • Post review findings

Summary

This PR cleanly splits the monolithic helm/k8s_reporter.mdx (397 lines) into 8 focused subpages. The second commit (d179007) already addressed all three comments from the earlier automated review — theme attributes removed, <CardGroup> added to the overview, and the breaking-change note moved to the upgrading page. The result is solid.

Navigation: All 8 new pages are registered in config/navigation.json. ✅
Redirect: /helm/k8s_reporter/helm/k8s_reporter/overview in place. ✅
No relative links: Confirmed — all internal links use root-relative paths. ✅
Frontmatter: Every new page has title and description. ✅
Diátaxis: Good separation — overview (explanation), prerequisites/installing/upgrading/uninstalling (how-to), configuration (reference), tls-proxy and karpenter (how-to). ✅
Tutorial deep-link: Updated from anchor-based link to the new dedicated page. ✅

Findings

Suggestiontutorials/rotating_api_keys.mdx:107 and getting_started/enforce_policies.md:151 still link to /helm/k8s_reporter (the old path). The redirect handles this fine, so nothing is broken, but updating them to /helm/k8s_reporter/overview (or a more specific subpage) would avoid the redirect hop. The changelog/index.mdx entries are historical and fine to leave as-is. Very low priority.

No critical or improvement-level issues found. The content split is accurate, the cross-links between new pages are well-placed (e.g. installing → configuration reference, configuration → karpenter, configuration → tls-proxy), and the writing style is consistent with the rest of the site.

Verdict: Looks good to merge. 👍

@mintlify

mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor Author

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

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

Comment thread helm/k8s_reporter/installing.mdx Outdated
Comment thread helm/k8s_reporter/overview.mdx Outdated
Comment thread helm/k8s_reporter/overview.mdx Outdated
@mbevc1 mbevc1 merged commit f649f9a into main Jul 3, 2026
6 checks passed
@mbevc1 mbevc1 deleted the mintlify/4a950f8f branch July 3, 2026 16:33
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