Docs: sync upstream clickhouse-operator docs updates#144
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
Syncs documentation changes from clickhouse/clickhouse-operator commit
a718cc9("fix: track users reload separately of server config" #218) into the Mintlify mirror underproducts/kubernetes-operator/.cc @grigorypv for review (original author of the upstream docs changes).
Changes
overview.mdx— Added "Monitoring" entry to the list of guides.guides/introduction.mdx— TwoReplicatedengine links re-prefixed to/core/reference/engines/database-engines/replicated.guides/configuration.mdx— Memory request bumped to512Mi(was256Mi); memory limit reduced to512Mi(was1Gi); new "External Secret" section (#external-secret) coveringspec.externalSecret, required keys, andObservevsManagepolicy.guides/monitoring.mdx— New page (added to nav and to overview).install/olm.mdx— Trailing newline added.reference/api-reference.mdx— NewAdditionalPorttype section and correspondingadditionalPortsfield onClickHouseClusterSpec; updated description forresourcesto mention SMP deep-merge behavior; added intro sentence under the page heading.navigation.json— Addedproducts/kubernetes-operator/guides/monitoringunder the Guides group.Conflicts / issues
Files were copied verbatim from upstream as instructed. The following pre-existing upstream link issues now exist in the Mintlify mirror and surface in
mint broken-links. They should be fixed upstream first, then re-synced:guides/introduction.mdx— Links to/core/reference/engines/database-engines/replicated(×2). The Mintlify path is/reference/engines/database-engines/replicated(no/coreprefix).guides/configuration.mdx— Links to/core/concepts/features/configuration/server-config/configuration-files#example-1,/core/reference/settings/server-settings/settings, and/core/concepts/features/configuration/settings/settings-users— same/coreprefix issue.guides/monitoring.mdx— Links to/operations/server-configuration-parameters/settings#prometheus, which does not resolve in the Mintlify site.overview.mdx— The new "Monitoring" bullet links to/products/kubernetes-operator/guides/introduction(likely meant to be/products/kubernetes-operator/guides/monitoring).mint validatepasses.Note
Low Risk
Documentation-only sync with no runtime changes; risk is limited to broken internal links from verbatim
/core/paths until corrected.Overview
Syncs upstream clickhouse-operator documentation into the Mintlify
products/kubernetes-operator/mirror.guides/configuration.mdxupdates documented default ClickHouse container memory to 512Mi for both requests and limits (limit down from 1Gi). It adds large new guide sections forspec.externalSecret(required keys, Observe vs Manage, status troubleshooting),spec.additionalPorts(reserved ports/names, MySQL protocol example), and version probe /upgradeChannel(status conditions,versionProbeTemplate, operator flags). Several cross-doc links are re-pointed to/core/...paths.guides/monitoring.mdxis a new guide for scraping and securing the operator controller metrics (/metrics, HelmServiceMonitor, RBAC, PromQL, sample alerts).navigation.jsonregisters it under Guides.reference/api-reference.mdxdocumentsAdditionalPortandadditionalPortsonClickHouseClusterSpec, and revisescontainerTemplate.resourcesto describe whole-object application instead of SMP deep-merge.guides/introduction.mdxupdates Replicated engine links to/core/reference/....overview.mdxdrops the incorrect Monitoring guide bullet that linked to Introduction. Minor whitespace ininstall/olm.mdx.Note: Mirrored
/core/...and some monitoring cross-links may still fail Mintlifybroken-linksuntil paths are fixed upstream or in a follow-up.Reviewed by Cursor Bugbot for commit 2116818. Bugbot is set up for automated code reviews on this repo. Configure here.