Docs: sync upstream clickhouse-operator docs updates#84
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 changes from
clickhouse/clickhouse-operator/docsintoproducts/kubernetes-operator/.cc @Slach @Blargian for review (authors of the upstream changes).
Changes
Syncs two upstream commits:
feat: allow exposing additional ports on ClickHouse service and pods(@Slach / Pervakov Grigorii)reference/api-reference.mdx: adds the newAdditionalPorttype section and theadditionalPortsfield onClickHouseClusterSpec.docs: add Mintlify frontmatter to docs pages(@Blargian)install/olm.mdx: removes a trailing blank line.Files modified:
products/kubernetes-operator/guides/configuration.mdxproducts/kubernetes-operator/guides/introduction.mdxproducts/kubernetes-operator/install/olm.mdxproducts/kubernetes-operator/reference/api-reference.mdxConflicts / issues
Files were copied exactly as-is from upstream per the sync policy. The following issues exist upstream and must be fixed in
clickhouse/clickhouse-operatorbefore this PR is merged:Broken internal links (5 total, reported by
mint broken-links). Upstream uses paths that are missing the/core/prefix used in this Mintlify deployment. These were previously patched downstream and the patch is now reverted by this sync: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(x2) → should be/core/reference/...mint validatepasses.mint broken-linksreports the 5 links above — all pre-existing in upstream.Context
Triggered by merge of
f5415de(an unrelated styling fix) onmain, which re-ran the upstream sync workflow and picked up the changes accumulated upstream since the last sync.Note
Medium Risk
Documentation-only, but reverted /core/-prefixed links introduce five known broken internal links until fixed upstream or patched downstream.
Overview
Syncs upstream clickhouse-operator docs into
products/kubernetes-operator/, mainly documenting extra TCP ports on ClickHouse pods/services and a few editorial tweaks.The API reference adds the
AdditionalPorttype and documentsspec.additionalPortsonClickHouseCluster, noting the operator only opens ports on the Pod and headless Service—ClickHouse must still be configured to listen on them.Configuration and introduction guides now link to core docs at paths without the
/core/prefix (e.g. Replicated engine and server/users settings). That matches upstream but breaks internal links in this Mintlify site unless paths are re-prefixed.install/olm.mdxonly drops a trailing blank line.Reviewed by Cursor Bugbot for commit 49f23a8. Bugbot is set up for automated code reviews on this repo. Configure here.