Skip to content

docs: Split Keeper page into sub-sections#6386

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

docs: Split Keeper page into sub-sections#6386
Harsh-pa-thak wants to merge 8 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 restructure with permanent redirects; no runtime or product behavior changes.

Overview
Reorganizes the ~1,400-line ClickHouse Keeper doc into four pages under docs/guides/sre/keeper/: Overview (/guides/sre/keeper/overview), Setup, Reference, and Guides, with the former index.md content removed in favor of this structure (same pattern as the Kubernetes Operator section).

Navigation and links now point at the overview entry: FAQ operations, manage-and-deploy index, and the TLS guide’s 4lw link target Reference for four-letter-word commands. The sidebar replaces a single keeper/index item with a collapsible ClickHouse Keeper category that autogenerates from the guides/sre/keeper directory; _category_.yml drops the old generated-index slug.

Redirects in vercel.json send legacy URLs (clickhouse-keeper, /docs/guides/sre/clickhouse-keeper, /docs/en/operations/clickhouse-keeper/, etc.) to /docs/guides/sre/keeper/overview.

Reviewed by Cursor Bugbot for commit 5ff3c2e. 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.

@dhtclk dhtclk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution for the most part looks good! Just a few things:

  • Please add a redirect from /guides/sre/keeper/clickhouse-keeper to the new overview page, else existing links pointed to that old slug will break.
  • There is an accidental deletion that should not be included with this change.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was deleted when it shouldn't have been. Likely a stale fork.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching both of these! I'll add the redirect for the old Keeper slug and restore the changelog file — that deletion was unintentional, likely from my fork being out of sync. Pushing a fix shortly

@vercel

vercel Bot commented Jun 17, 2026

Copy link
Copy Markdown

@Harsh-pa-thak is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

@Harsh-pa-thak Harsh-pa-thak requested a review from dhtclk June 17, 2026 06:02

@dhtclk dhtclk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one small thing that's breaking CI!

Comment thread docs/guides/sre/keeper/01_overview.md Outdated
keywords: ['Keeper', 'ZooKeeper', 'clickhouse-keeper']
description: 'ClickHouse Keeper, or clickhouse-keeper, replaces ZooKeeper and provides replication and coordination.'
title: 'ClickHouse Keeper'
doc_type: 'overview'

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
doc_type: 'overview'
doc_type: 'landing-page'

the doc_type: 'overview' is failing CI (DocsCheck). overview isn't a valid value; it needs to be one of guide, reference, changelog, or landing-page. Since this is the section's landing page, landing-page is the right fit.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for flagging the doc_type issue!

While addressing that, I noticed the DocsCheck build was also failing due to 3 additional frontmatter violations in the same directory. I've fixed all of them in this commit:

02_setup.md — sentence casing: "ClickHouse Keeper Setup" → "ClickHouse Keeper setup"
03_reference.md — sentence casing: "ClickHouse Keeper Reference" → "ClickHouse Keeper reference"
04_guides.md — sentence casing: "ClickHouse Keeper Guides" → "ClickHouse Keeper guides"
All changes are strictly limited to frontmatter fields and are in line with the style guide. No content was modified.

@Harsh-pa-thak Harsh-pa-thak requested a review from dhtclk June 18, 2026 10:37
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

3 participants