Docs: sync upstream clickhouse-operator docs updates#77
Closed
mintlify[bot] wants to merge 1 commit into
Closed
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
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 latest
docs/updates from clickhouse/clickhouse-operator intoproducts/kubernetes-operator/.Changes
products/kubernetes-operator/reference/api-reference.mdx— adds the newAdditionalPorttype andadditionalPortsfield onClickHouseClusterSpec(from upstream #197, cc @GrigoryPervakov).products/kubernetes-operator/guides/configuration.mdx— link path updates.products/kubernetes-operator/guides/introduction.mdx— link path updates.products/kubernetes-operator/install/olm.mdx— minor trailing-newline cleanup.Context
Upstream PRs picked up in this sync:
Per the sync policy, upstream is copied exactly as-is. The following broken links were introduced because upstream uses bare ClickHouse doc paths, but this Mintlify site mounts those docs under
/core/:In
products/kubernetes-operator/guides/configuration.mdx:/concepts/features/configuration/server-config/configuration-files#example-1→ should be/core/concepts/.../reference/settings/server-settings/settings→ should be/core/reference/.../concepts/features/configuration/settings/settings-users→ should be/core/concepts/...In
products/kubernetes-operator/guides/introduction.mdx:/reference/engines/database-engines/replicated(×2) → should be/core/reference/...These should be fixed upstream in
clickhouse/clickhouse-operatorand re-synced. Tagging @GrigoryPervakov and @Blargian for review.Note
Low Risk
Documentation-only sync with no runtime or security impact; the main caveat is potentially broken internal doc links until paths are corrected.
Overview
Syncs upstream clickhouse-operator docs into
products/kubernetes-operator/.The API reference now documents
AdditionalPortand the optionaladditionalPortsfield onClickHouseClusterSpec, describing extra TCP ports on ClickHouse pods and the operator headless Service (Kubernetes exposure only; ClickHouse listen config is still the operator’s responsibility).Configuration and introduction guides update cross-links from
/core/...paths to shorter/concepts/...and/reference/...URLs (upstream style). On this Mintlify site those paths may not resolve unless prefixed with/core/—fix upstream or adjust on re-sync.OLM install doc gets a minor trailing-newline change only.
Reviewed by Cursor Bugbot for commit 1582d1b. Bugbot is set up for automated code reviews on this repo. Configure here.