Docs: sync upstream clickhouse-operator docs updates#248
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
arekborucki
approved these changes
Jun 23, 2026
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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 the
docs/directory fromclickhouse/clickhouse-operator(commit5f292b7, PR #243 by @arekborucki) intoproducts/kubernetes-operator/in this repo.cc @arekborucki for review.
Changes
guides/storage.mdx— dedicated "Storage and volumes" guide extracted from the configuration guide.overview.mdx, allguides/*.mdx(configuration, introduction, monitoring, scaling, tls), allinstall/*.mdx(helm, kubectl, olm), andreference/api-reference.mdx— synced verbatim from upstream. Notable content changes:guides/configuration.mdx: storage section trimmed (content moved to newstorage.mdx).guides/monitoring.mdx,guides/scaling.mdx,guides/tls.mdx:positionbumped to make room for the new storage guide;tls.mdxclarifies the server keypair secret shape.install/kubectl.mdx: now recommends--server-side --force-conflictsand documents the description-stripped CRD variant for client-side apply.reference/api-reference.mdx: addsCABundleSelectortype; addsadditionalVolumeClaimTemplatesfield on cluster spec.guides/storagebetweenconfigurationandmonitoringinproducts/kubernetes-operator/navigation.jsonto match upstreamdocs/navigation.json.Conflicts / issues
reference/api-reference.mdxline 83 contains a literal<name>inside a markdown table cell (/var/lib/clickhouse/disks/<name>). MDX parses this as an unclosed JSX tag, which causesmint broken-links/mint validateto fail with:Per the sync instructions, the file is copied as-is and the fix should land upstream first (e.g. escape as
<name>or wrap in backticks:`<name>`).Context
Upstream commit: ClickHouse/clickhouse-operator@5f292b7 — "docs: extract storage related documentation as a dedicated guide (#243)".