docs: Split Keeper page into sub-sections#6386
Open
Harsh-pa-thak wants to merge 3 commits into
Open
Conversation
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.
Fixes #5904
The Keeper page was a single ~1,400 line page mixing many unrelated concerns. This splits it into four focused sub-pages — Overview, Setup, Reference, and Guides — following the same pattern as the ClickHouse Operator section.
No content was changed, only re-organised.
Note
Low Risk
Documentation-only reorganization; main risk is broken inbound links to the old
/guides/sre/keeper/clickhouse-keeperorindex.mdURLs unless redirects are added elsewhere.Overview
Replaces the single ~1,400-line ClickHouse Keeper page with four focused docs (Overview, Setup, Reference, Guides), aligned with the ClickHouse Operator section layout.
The former
index.mdcontent is removed and redistributed: high-level intro on Overview; configuration, run instructions, ZooKeeper migration, and quorum recovery on Setup; 4lw commands, HTTP control, feature flags, disks, Prometheus, and unsupported features on Reference; cluster walkthroughs,{uuid}paths, dynamic reconfiguration, and single-node expansion on Guides.The Keeper category drops the Docusaurus generated index (
linkblock in_category_.yml). Cross-links inside Setup now point at the new slugs (e.g. reconfiguration → Guides, HTTP control → Reference) instead of same-page anchors.Reviewed by Cursor Bugbot for commit 53b249f. Bugbot is set up for automated code reviews on this repo. Configure here.