Skip to content

Docs: sync upstream clickhouse-operator docs updates#179

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/52ed1bc9
Open

Docs: sync upstream clickhouse-operator docs updates#179
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/52ed1bc9

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs documentation updates from the upstream clickhouse/clickhouse-operator repo (commit f5d7604 — "docs: scaling guide (#222)") into products/kubernetes-operator/.

cc @arekborucki for review.

Changes

New pages:

  • guides/monitoring.mdx — Prometheus metrics monitoring guide
  • guides/scaling.mdx — Scaling guide

Updated pages (copied verbatim from upstream):

  • overview.mdx — adds Monitoring link to the guides list
  • guides/introduction.mdx — title/H1 normalization; link target changes
  • guides/configuration.mdx — title/H1 normalization; resource defaults updated (256Mi→512Mi requests, 1Gi→512Mi limits); large new "External Secret" section removed
  • install/olm.mdx — trivial whitespace
  • reference/api-reference.mdx — adds AdditionalPort type/section, additionalPorts field, and updates resources field description (SMP deep-merge wording removed)
  • navigation.json — adds guides/monitoring and guides/scaling entries

Conflicts / issues to note

  • Internal links use /core/reference/... prefix. guides/introduction.mdx now contains two links to /core/reference/engines/database-engines/replicated (previously /reference/engines/... in the deployed copy). These were copied verbatim from upstream per the sync instructions but likely need to be fixed upstream — there is no /core/ route in this docs site, so they will resolve as broken links.
  • mint validate timed out in the sandbox and could not be run to completion; no other validation was performed locally.

Note

Medium Risk
Large verbatim doc import may ship broken /core/... internal links and outdated overview guide list; content is documentation-only with no runtime impact.

Overview
Syncs upstream ClickHouse Operator docs into products/kubernetes-operator/, with the largest updates in the configuration guide and two new guides wired into navigation.

The configuration guide is retitled (sidebar title vs on-page H1), updates documented default container memory (512Mi requests and limits), and adds long sections on spec.externalSecret (Observe/Manage, required keys, status troubleshooting), spec.additionalPorts (reserved ports/names, MySQL example), version probe / upgradeChannel, and spec.settings.logger. Several cross-links now use a /core/... path prefix, which may not match this docs site’s routes.

New: guides/monitoring.mdx (Prometheus scrape, Helm ServiceMonitor, RBAC, PromQL/alerts) and guides/scaling.mdx (replica/shard/Keeper scaling and status conditions). navigation.json lists both under Guides.

API reference adds AdditionalPort / spec.additionalPorts and revises containerTemplate.resources to “applied as a whole” instead of deep-merge wording. Introduction gets the same title/H1 pattern and /core/... Replicated engine links.

Reviewed by Cursor Bugbot for commit b06fde0. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Jun 11, 2026, 1:34 PM

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