Skip to content

docs: Split Keeper page into sub-sections#6386

Open
Harsh-pa-thak wants to merge 3 commits into
ClickHouse:mainfrom
Harsh-pa-thak:main
Open

docs: Split Keeper page into sub-sections#6386
Harsh-pa-thak wants to merge 3 commits into
ClickHouse:mainfrom
Harsh-pa-thak:main

Conversation

@Harsh-pa-thak

@Harsh-pa-thak Harsh-pa-thak commented Jun 14, 2026

Copy link
Copy Markdown

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-keeper or index.md URLs 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.md content 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 (link block 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.

@Harsh-pa-thak Harsh-pa-thak requested a review from a team as a code owner June 14, 2026 04:51
@CLAassistant

CLAassistant commented Jun 14, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Keeper page

2 participants