Restructure Managed Postgres sidebar and add migration overview by deeox · Pull Request #6279 · ClickHouse/clickhouse-docs

deeox · 2026-05-26T11:36:10Z

Summary

Reorder the Managed Postgres sidebar into four functional groups (Get started, Use it, Configure, Operate & reference) so Data migration sits next to Connection rather than at the bottom. Group boundaries are annotated with comments in sidebars.js.
Extensions, Monitoring, and Data migration are now categories with overview pages via link: { type: 'doc' }, so clicking the category label opens its landing page.
New page: docs/cloud/managed-postgres/migrations/overview.md — a decision guide comparing ClickPipes, PeerDB, pg_dump/pg_restore, and logical replication along three axes: CDC support, where it runs, and best-for scenario.
Move pg_clickhouse docs from docs/integrations/tools/data-integration/pg_clickhouse/ to docs/cloud/managed-postgres/extensions/pg_clickhouse/. Slugs updated to /cloud/managed-postgres/extensions/pg_clickhouse[/tutorial,/reference]. The old pg_clickhouse category is removed from the integrations sidebar.
Redirects in vercel.json so external links to the three old /docs/integrations/pg_clickhouse[...] URLs forward to the new locations.
Internal cross-references updated in extensions.md and quickstart.md to point at the new URLs.
BetaBadge on the migration overview now passes link, galaxyTrack, and galaxyEvent="docs.managed-postgres.migration-overview-beta", matching the convention used on other Managed Postgres beta pages.
PR template fix: the URL-change checklist now points at vercel.json rather than docusaurus.config.js, matching the explicit note at docusaurus.config.en.js:330 ("If you need to redirect a page please do so from vercel.json").

Sidebar before → after

Before: flat list, Extensions/Monitoring as leaves, Data migration at the bottom.

After:

Get started — Overview, Quickstart, Pricing, Connection, Data migration (category, with overview)
Use it — ClickHouse integration, HA, Read replicas, Scaling, Backup and restore, Security
Configure — Settings, Extensions (category expanded, with overview, includes nested pg_clickhouse), Upgrades
Operate & reference — Monitoring (category, with overview), Benchmarks, OpenAPI, FAQ

Test plan

yarn start and verify the Managed Postgres sidebar renders the four groups in the order above
Confirm clicking Extensions, Monitoring, and Data migration category labels opens their respective overview pages
Confirm pg_clickhouse nested category expands and the three sub-items (introduction, tutorial, reference) load at the new URLs
Confirm the old URLs (/docs/integrations/pg_clickhouse, /tutorial, /reference) 308-redirect to the new locations after deploy
Confirm pg_clickhouse no longer appears under Integrations → Data integration
Vale clean on the new overview page (pre-existing heading-case errors in the moved pg_clickhouse pages are intentionally out of scope)

🤖 Generated with Claude Code

Note

Low Risk
Documentation and navigation-only changes with permanent redirects for moved URLs; no application or security logic affected.

Overview
Reorganizes the Managed Postgres (Beta) docs navigation into clearer groups—Get started, Use it, Configure, and Operate & reference—and moves Data migration up next to Connection instead of leaving it at the bottom.

Adds a new Data migration overview at /cloud/managed-postgres/migrations/overview that compares ClickPipes, PeerDB, pg_dump/pg_restore, and logical replication. Extensions, Monitoring, and Data migration are now sidebar categories whose labels link to their overview pages.

pg_clickhouse documentation is relocated from Integrations to Managed Postgres → Extensions, with slugs under /cloud/managed-postgres/extensions/pg_clickhouse. Permanent vercel.json redirects preserve the old /docs/integrations/pg_clickhouse URLs; internal links in extensions.md and quickstart.md point to the new paths. The Integrations Data integration → pg_clickhouse subtree is removed from sidebars.js.

The PR template checklist now tells contributors to add URL redirects in vercel.json (not docusaurus.config.js). Vale heading exceptions are extended for terms used in the moved pg_clickhouse pages.

^{Reviewed by Cursor Bugbot for commit a824d31. Bugbot is set up for automated code reviews on this repo. Configure here.}

Reorder Managed Postgres sidebar into four functional groups (Get started, Use it, Configure, Operate & reference) so Data migration sits with Connection rather than at the bottom. Convert Extensions, Monitoring, and Data migration from leaf entries into categories with overview pages via link: { type: 'doc' }. Cross-list pg_clickhouse under Extensions. Add a new Data migration overview that compares ClickPipes, PeerDB, pg_dump/pg_restore, and logical replication so readers can pick the right path before clicking through. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

vercel · 2026-05-26T11:36:16Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs	Ready	Preview, Comment	May 26, 2026 8:06pm
clickhouse-docs-jp	Building	Preview, Comment	May 26, 2026 8:06pm

3 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs-ko	Ignored	Preview	May 26, 2026 8:06pm
clickhouse-docs-ru	Ignored	Preview	May 26, 2026 8:06pm
clickhouse-docs-zh	Ignored	Preview	May 26, 2026 8:06pm

mintlify · 2026-05-26T11:50:06Z

Docs PR opened: ClickHouse/mintlify-docs-dev#60

Restructured the Managed Postgres sidebar into four functional groups and added a new migration overview page comparing four paths.

Relocate the three pg_clickhouse pages from docs/integrations/tools/data-integration/pg_clickhouse/ to docs/cloud/managed-postgres/extensions/pg_clickhouse/ to match where the extension is documented and surfaced in the product. Update slugs to /cloud/managed-postgres/extensions/pg_clickhouse[/tutorial,/reference], internal cross-links in extensions.md and quickstart.md, and the nested sidebar doc IDs. Drop the old pg_clickhouse autogenerated category from the data-integration sidebar. Add vercel.json redirects so external links to the old /docs/integrations/pg_clickhouse URLs forward to the new locations. Also: pass link/galaxyTrack/galaxyEvent props to BetaBadge on the new data migration overview, matching the pattern used elsewhere in Managed Postgres. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

docusaurus.config.en.js:330 explicitly says redirects belong in vercel.json — the @docusaurus/plugin-client-redirects entry is commented out with that note. Update the PR template to match. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

mintlify · 2026-05-26T14:24:59Z

Docs PR opened: ClickHouse/mintlify-docs-dev#62

Restructured the Managed Postgres sidebar into four groups, added a migrations overview page, and moved pg_clickhouse under Extensions.

Convert title-cased H2/H3/H4 headings to sentence case to clear ClickHouse.Headings Vale errors flagged on the moved files. Two headings that referenced hyphenated/multi-word identifiers couldn't be sentence-cased cleanly: 'TPC-H' is now backticked to skip the style check, and 'PREPARE, EXECUTE, DEALLOCATE' is renamed to 'Prepared statements' since the section already documents that protocol. The 'RedHat/CentOS/Yum' heading becomes 'RPM distros' to avoid the mixed-case issue. Anchors are preserved on all headings. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

theory

I don't think any of these changes are necessary, and some are simply incorrect. Any you do decide to commit, however, please also sync back to the source docs in the pg_clickhouse project.

mshustov · 2026-05-26T18:42:17Z

 sidebar_label: 'Introduction'
 description: 'Run analytics queries on ClickHouse right from PostgreSQL without rewriting any SQL'
-slug: '/integrations/pg_clickhouse'
+slug: '/cloud/managed-postgres/extensions/pg_clickhouse'


ok for the change

mshustov

ok for moving pg_clickhouse from/integrations

Restore semantically meaningful headings flagged in review by the upstream pg_clickhouse author, and one consistent-spacing fix they didn't flag explicitly: - 'TPC-H benchmark' (was backticked) — drop backticks since TPC-H is a benchmark name, not a code symbol; add TPC-H to Headings.yml exceptions so the hyphenated acronym passes Vale - 'Unix' (was 'Generic build') — restore the OS context the section actually documents - 'RedHat / CentOS / yum' (was 'RPM distros') — restore the distro names users search for; lowercase 'yum' (the binary name) passes Vale via the existing PascalCase regex on RedHat/CentOS - 'PREPARE EXECUTE DEALLOCATE' (was 'Prepared statements') — restore the SQL-keyword pattern used by sibling reference headings; drop the commas so space-separated all-caps tokens pass Vale - 'Debian / Ubuntu / APT' — restore the spaced-slash style to match the RedHat heading and the original upstream form; add Debian and Ubuntu to Headings.yml exceptions Leaving the H2 sentence-case changes ('Getting started', 'Data types', etc.) — Vale's ClickHouse.Headings rule applies to all heading levels, not H3+ as the review comment suggests. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

theory · 2026-05-26T18:59:08Z

Why the hell do you call me "upstream author" instead of using my name?? 😂

Restore reviewer-requested heading forms: - 'Test case: TPC-H' (was 'TPC-H benchmark') — reviewer's follow-up suggestion; sentence-cases 'case' but keeps the original framing. TPC-H already added to Headings.yml in prior commit - 'General Unix' (was 'Unix') — reviewer notes specific Unixes are covered below, so 'General' is meaningful. Add Unix to Headings.yml - 'RedHat / CentOS / Yum' (was 'RedHat / CentOS / yum') — capital Y per Red Hat's own docs (linked in review). Add Yum to Headings.yml - 'PREPARE, EXECUTE, DEALLOCATE' (was space-separated) — restore commas to match the SQL-keyword pattern of sibling reference headings. Add as a literal Headings.yml exception Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

dhtclk

There's a few small word duplication typos that should be fixed before merging.

A question that's probably already been well thought out but want to call it out - moving these docs to strictly under managed postgres may impact discoverability to self-managed users, is that significant enough to consider, or more of an edge case?

Apply review suggestions from dhtclk: - tutorial.md: 'the the 1000 trips' -> 'the 1000 trips' - reference.md: 'any of of its features' -> 'any of its features' Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

deeox · 2026-05-26T20:11:40Z

A question that's probably already been well thought out but want to call it out - moving these docs to strictly under managed postgres may impact discoverability to self-managed users, is that significant enough to consider, or more of an edge case?

@dhtclk you have a valid point, but I feel it was less discoverable before this change anyways. I couldn't find a better place currently where we can showcase this extension better. Do you have any suggestions?

dhtclk · 2026-05-26T20:20:05Z

A question that's probably already been well thought out but want to call it out - moving these docs to strictly under managed postgres may impact discoverability to self-managed users, is that significant enough to consider, or more of an edge case?

@dhtclk you have a valid point, but I feel it was less discoverable before this change anyways. I couldn't find a better place currently where we can showcase this extension better. Do you have any suggestions?

Fair point - I don't clearly have a better spot either.

We could leave a single breadcrumb entry in the Integrations sidebar where it was so that it still gets surfaced in the old spot. Else non-blocking really. Just wanted to call it out.

theory

Thanks, looks good now; I'll fix the double words in the upstream docs.

Only request is in the future to review and edit text generated by the LLM.

deeox requested a review from a team as a code owner May 26, 2026 11:36

deeox marked this pull request as draft May 26, 2026 11:37

vercel Bot deployed to Preview – clickhouse-docs May 26, 2026 11:47 View deployment

mintlify Bot mentioned this pull request May 26, 2026

docs: restructure Managed Postgres sidebar and add migration overview ClickHouse/mintlify-docs-dev#60

Open

deeox and others added 3 commits May 26, 2026 17:57

Add link to pg_clickhouse introduction in sidebar

2a49607

vercel Bot deployed to Preview – clickhouse-docs May 26, 2026 13:02 View deployment

deeox marked this pull request as ready for review May 26, 2026 14:12

deeox requested a review from a team as a code owner May 26, 2026 14:12

mintlify Bot mentioned this pull request May 26, 2026

docs: restructure Managed Postgres sidebar and add migration overview ClickHouse/mintlify-docs-dev#62

Open

theory approved these changes May 26, 2026

View reviewed changes

vercel Bot deployed to Preview – clickhouse-docs May 26, 2026 17:13 View deployment

theory requested changes May 26, 2026

View reviewed changes

mshustov reviewed May 26, 2026

View reviewed changes

mshustov approved these changes May 26, 2026

View reviewed changes

theory requested changes May 26, 2026

View reviewed changes

vercel Bot deployed to Preview – clickhouse-docs May 26, 2026 19:04 View deployment

deeox requested a review from theory May 26, 2026 19:27

achudnovskij approved these changes May 26, 2026

View reviewed changes

dhtclk reviewed May 26, 2026

View reviewed changes

Comment thread docs/cloud/managed-postgres/extensions/pg_clickhouse/tutorial.md Outdated

Comment thread docs/cloud/managed-postgres/extensions/pg_clickhouse/reference.md Outdated

vercel Bot deployed to Preview – clickhouse-docs May 26, 2026 19:36 View deployment

Fix duplicate-word typos in pg_clickhouse docs

a824d31

Apply review suggestions from dhtclk: - tutorial.md: 'the the 1000 trips' -> 'the 1000 trips' - reference.md: 'any of of its features' -> 'any of its features' Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

vercel Bot deployed to Preview – clickhouse-docs May 26, 2026 20:06 View deployment

dhtclk approved these changes May 26, 2026

View reviewed changes

theory approved these changes May 26, 2026

View reviewed changes

Conversation

deeox commented May 26, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Sidebar before → after

Test plan

Uh oh!

vercel Bot commented May 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mintlify Bot commented May 26, 2026

Uh oh!

mintlify Bot commented May 26, 2026

Uh oh!

theory left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mshustov May 26, 2026

Choose a reason for hiding this comment

Uh oh!

mshustov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theory commented May 26, 2026

Uh oh!

dhtclk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

deeox commented May 26, 2026

Uh oh!

dhtclk commented May 26, 2026

Uh oh!

theory left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

deeox commented May 26, 2026 •

edited by cursor Bot

Loading

vercel Bot commented May 26, 2026 •

edited

Loading