Docs: sync upstream clickhouse-operator docs updates#203
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
arekborucki
approved these changes
Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Syncs upstream
clickhouse/clickhouse-operatordocs commite90a6a5("docs: tls configuration (#223)") authored by @arekborucki intoproducts/kubernetes-operator/.cc @arekborucki for review.
Changes
guides/monitoring.mdx,guides/scaling.mdx,guides/tls.mdx.overview.mdx,guides/configuration.mdx,guides/introduction.mdx,install/olm.mdx,reference/api-reference.mdx.install/helm.mdxandinstall/kubectl.mdxwere 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):
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/settingsproducts/kubernetes-operator/guides/introduction.mdx:104and:117→/core/reference/engines/database-engines/replicatedPreviously, the workspace copy used the correct
/reference/...paths; the upstream sync regresses these.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.overview.mdx— upstream removed the "Monitoring" bullet that the workspace copy had added under the guides list. The newguides/monitoring.mdxpage exists but is no longer linked from the overview page. Consider re-adding upstream.reference/api-reference.mdx— substantive content edits (addedAdditionalPorttype andadditionalPortsfield; resource-merging description rewritten). Carried through verbatim.mint broken-linksvalidation timed out locally during this sync and could not be completed;mint validatepassed 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), andtls.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, andspec.settings.logger; links to the TLS guide; updates documented default container memory (512Mirequest/limit). API reference documentsAdditionalPort,additionalPortsonClickHouseClusterSpec, and revisesContainerTemplateSpec.resourcesmerge 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.