Skip to content

Docs: sync upstream clickhouse-operator docs updates#203

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

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

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Syncs upstream clickhouse/clickhouse-operator docs commit e90a6a5 ("docs: tls configuration (#223)") authored by @arekborucki into products/kubernetes-operator/.

cc @arekborucki for review.

Changes

  • New guides added: guides/monitoring.mdx, guides/scaling.mdx, guides/tls.mdx.
  • Updated: overview.mdx, guides/configuration.mdx, guides/introduction.mdx, install/olm.mdx, reference/api-reference.mdx.
  • Navigation updated to include the three new guide pages (monitoring, scaling, tls).
  • install/helm.mdx and install/kubectl.mdx were already in sync — no changes.

Files were copied verbatim from upstream docs/ as requested.

Conflicts / issues to address upstream

The following are introduced by this sync and should be fixed in the upstream repo (not patched here):

  1. Broken internal links to /core/reference/... — these paths do not exist on this docs site (correct prefix is /reference/...):

    • products/kubernetes-operator/guides/configuration.mdx:782/core/reference/settings/server-settings/settings
    • products/kubernetes-operator/guides/introduction.mdx:104 and :117/core/reference/engines/database-engines/replicated

    Previously, the workspace copy used the correct /reference/... paths; the upstream sync regresses these.

  2. Frontmatter/heading style change — upstream replaced descriptive titles (e.g. title: ClickHouse Operator configuration guide) with short titles (title: 'Configuration') and removed the redundant top-level # Heading. This is a stylistic change carried through from upstream as-is.

  3. overview.mdx — upstream removed the "Monitoring" bullet that the workspace copy had added under the guides list. The new guides/monitoring.mdx page exists but is no longer linked from the overview page. Consider re-adding upstream.

  4. reference/api-reference.mdx — substantive content edits (added AdditionalPort type and additionalPorts field; resource-merging description rewritten). Carried through verbatim.

  5. mint broken-links validation timed out locally during this sync and could not be completed; mint validate passed cleanly.


Note

Low Risk
Documentation-only sync with no runtime changes; main follow-up is fixing /core/reference/... links and optionally restoring overview links to the new guides.

Overview
Syncs upstream ClickHouse Kubernetes Operator documentation into products/kubernetes-operator/, with a large expansion of the configuration guide and three new task-oriented guides.

New guides: monitoring.mdx (Prometheus/ServiceMonitor, secured /metrics, health probes, PromQL/alerts), scaling.mdx (replica/shard/Keeper scaling and status conditions), and tls.mdx (cert-manager walkthrough, Keeper TLS, troubleshooting). Navigation lists all three under Guides.

Configuration guide adds sections on external secrets (Observe/Manage), additionalPorts, version probe / upgradeChannel, and spec.settings.logger; links to the TLS guide; updates documented default container memory (512Mi request/limit). API reference documents AdditionalPort, additionalPorts on ClickHouseClusterSpec, and revises ContainerTemplateSpec.resources merge behavior.

Smaller edits: introduction/configuration frontmatter titles shortened with explicit # headings restored; cross-links to core docs now use /core/... paths (may be broken on this site vs /reference/...). Overview no longer lists Monitoring/Scaling/TLS in the guides bullet list despite new pages and nav entries.

Reviewed by Cursor Bugbot for commit f218033. 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, 4:44 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