Docs: sync upstream clickhouse-operator docs updates#78
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 upstream docs changes from
clickhouse/clickhouse-operator(PR #197) into the Mintlify deployment copy underproducts/kubernetes-operator/.cc @GrigoryPervakov for review.
Changes
products/kubernetes-operator/reference/api-reference.mdx— adds the newAdditionalPorttype section and theadditionalPortsfield onClickHouseClusterSpec, sourced verbatim from upstreamdocs/reference/api-reference.mdx.products/kubernetes-operator/install/olm.mdx— minor trailing-newline alignment with upstream.Context
Upstream commit
7e82242(feat: allow exposing additional ports on ClickHouse service and pods, by @GrigoryPervakov) added a new CRD field and corresponding API reference docs. This PR mirrors that doc change here.Notes / conflicts
products/kubernetes-operator/guides/configuration.mdxandproducts/kubernetes-operator/guides/introduction.mdxalso diverge from upstream, but only in internal link prefixes (workspace uses/core/reference/...and/core/concepts/...while upstream uses/reference/...and/concepts/...). These are deployment-local routing adjustments, not upstream content changes, so they were intentionally not overwritten. If upstream should match these prefixes, that fix should be applied upstream first.api-reference.mdxwas copied verbatim from upstream per instructions; it contains no cross-doc links that would need re-prefixing.mint validate,mint broken-links) passes for the synced files; the two pre-existing broken links reported inintegrations/language-clients/java/jdbc.mdxare unrelated to this sync.Note
Low Risk
Documentation-only sync with no runtime or application logic changes.
Overview
Mirrors upstream clickhouse-operator API docs into the Mintlify copy under
products/kubernetes-operator/.api-reference.mdxdocuments the newAdditionalPorttype (name,port) and the optionaladditionalPortsfield onClickHouseClusterSpec, including that the operator exposes ports on the Pod and headless Service but does not configure ClickHouse to listen on them.install/olm.mdxonly gains a trailing newline to match upstream formatting.Reviewed by Cursor Bugbot for commit 97f435a. Bugbot is set up for automated code reviews on this repo. Configure here.