Skip to content

Docs: sync upstream clickhouse-operator docs updates#206

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5b4293a9
Open

Docs: sync upstream clickhouse-operator docs updates#206
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/5b4293a9

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Sync the docs/ directory from clickhouse/clickhouse-operator@8381d0c into products/kubernetes-operator/ verbatim.

cc @GrigoryPervakov for review (original author of the upstream docs).

Changes

New pages added under products/kubernetes-operator/guides/:

  • monitoring.mdx — Prometheus metrics and health probes for the operator process
  • scaling.mdx — scaling replicas, shards, and Keeper quorum
  • tls.mdx — end-to-end TLS with cert-manager

navigation.json updated to list the three new guides.

Updated pages (copied verbatim from upstream):

  • overview.mdx — drops the dangling “Monitoring” bullet that pointed at the introduction page
  • guides/configuration.mdx — new "External Secret" section, link to the new TLS guide, bumped Keeper resource defaults (512Mi)
  • guides/introduction.mdx — link target changes (see Conflicts)
  • install/olm.mdx — trailing newline only
  • reference/api-reference.mdx — adds AdditionalPort type / additionalPorts field, rewords ClickHouseSpec.resources deep-merge note

Context

The triggering commit (feat: add registry option to helm charts, #227) only touches helm chart files, not docs. The docs delta above accumulated from prior upstream changes that had not yet been mirrored here; this PR brings the mirror back in sync.

Conflicts / issues to flag

Copied as-is per the sync policy — these need to be fixed upstream first if they should differ:

  1. Internal links use upstream-relative paths. guides/introduction.mdx now links to /reference/engines/database-engines/replicated. That route exists in this Mintlify site, so the links resolve, but they are a sibling-site link rather than a /products/kubernetes-operator/... link — confirm this is intended.
  2. Frontmatter titles regressed to short forms. Previous values like title: ClickHouse Operator configuration guide and title: Introduction to the ClickHouse Operator were replaced by title: 'Configuration' and title: 'Introduction', and the long titles moved to in-body H1s. This duplicates the page title in the rendered page (Mintlify renders frontmatter title as H1). Recommend upstream pick one.
  3. Embedded H1 headings. guides/configuration.mdx and guides/introduction.mdx now contain an # ... H1 in the body in addition to the frontmatter title. Same duplicate-title concern as above.
  4. External link to /operations/.... guides/monitoring.mdx and guides/tls.mdx link to /operations/server-configuration-parameters/settings#... which is a ClickHouse Core docs path, not part of the operator product space. These resolve on this combined site but won't on a standalone operator docs deployment.
  5. navigation.json has no trailing newline (upstream removed it). Cosmetic only.

No content was edited locally to paper over any of these — fixes should land upstream and be re-synced.


Note

Low Risk
Documentation-only sync with no application or operator code changes; risk is limited to navigation, duplicate titles, and cross-site link paths in the docs site.

Overview
Mirrors upstream clickhouse-operator documentation into products/kubernetes-operator/, adding three guides (Monitoring, Scaling, Securing with TLS) and registering them in navigation.json.

The Configuration guide grows with External Secret (Observe/Manage), additionalPorts, version probe / upgradeChannel, and spec.settings.logger, plus a TLS cross-link and updated default container memory (512Mi). Introduction and configuration cross-links now use /core/... paths for ClickHouse core docs. Overview drops the broken Monitoring link. API reference documents AdditionalPort / additionalPorts and clarifies that container resources apply as a whole rather than deep-merge.

Several synced pages use short frontmatter titles with duplicate in-body H1s and some /operations/... links (Mintlify site concern, not operator runtime).

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

@mintlify

mintlify Bot commented Jun 15, 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 15, 2026, 7:13 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.

0 participants