Docs: sync upstream clickhouse-operator docs updates#206
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
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
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
Sync the
docs/directory from clickhouse/clickhouse-operator@8381d0c intoproducts/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 processscaling.mdx— scaling replicas, shards, and Keeper quorumtls.mdx— end-to-end TLS with cert-managernavigation.jsonupdated to list the three new guides.Updated pages (copied verbatim from upstream):
overview.mdx— drops the dangling “Monitoring” bullet that pointed at the introduction pageguides/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 onlyreference/api-reference.mdx— addsAdditionalPorttype /additionalPortsfield, rewordsClickHouseSpec.resourcesdeep-merge noteContext
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:
guides/introduction.mdxnow 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.title: ClickHouse Operator configuration guideandtitle: Introduction to the ClickHouse Operatorwere replaced bytitle: 'Configuration'andtitle: 'Introduction', and the long titles moved to in-body H1s. This duplicates the page title in the rendered page (Mintlify renders frontmattertitleas H1). Recommend upstream pick one.guides/configuration.mdxandguides/introduction.mdxnow contain an# ...H1 in the body in addition to the frontmattertitle. Same duplicate-title concern as above./operations/....guides/monitoring.mdxandguides/tls.mdxlink 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.navigation.jsonhas 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 innavigation.json.The Configuration guide grows with External Secret (
Observe/Manage),additionalPorts, version probe /upgradeChannel, andspec.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 documentsAdditionalPort/additionalPortsand 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.