Skip to content

docs: port clickhousectl install updates and restructure install nav#113

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/81d711cf
Open

docs: port clickhousectl install updates and restructure install nav#113
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/81d711cf

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Jun 3, 2026

Summary

Ports ClickHouse/clickhouse-docs#6334 — recommend clickhousectl local use stable for local installs and restructure the Install menu/landing page into Local development and Production server groups.

Changes

  • snippets/_cli_install.mdx — recommend clickhousectl local use stable and add the "Use vs install" note.
  • core/get-started/about/deployment-modes.mdx — switch the example to local use stable.
  • core/get-started/setup/self-managed/macos.mdx — drop deprecated Homebrew flow; use the shared CLI install snippet.
  • core/get-started/setup/self-managed/advanced.mdx — rename "Advanced install" → "Source & CI builds" (slug unchanged).
  • core/get-started/setup/self-managed/quick-install.mdx (slug /getting-started/quick-start/oss) — updated CLI install copy + symlink callout.
  • core/get-started/setup/install.mdx — landing page split into Cloud / Local development / Production server; dropped Windows and macOS cards.
  • core/get-started/setup/self-managed/overview.mdx — same Local development / Production server split; dropped Windows and macOS cards.
  • core/get-started/navigation.json — Self-managed sidebar now groups into Local development (Quick install, Docker, Source & CI builds) and Production server (Debian/Ubuntu, Redhat, Other Linux, NixOS). Windows and macOS removed from the menu; pages remain reachable by URL.

Notes / ambiguities

  • The upstream Docusaurus repo has two distinct files:

    • docs/getting-started/install/quick-install.md with slug /install/quick-install
    • docs/getting-started/quick-start/oss.mdx with slug /getting-started/quick-start/oss

    In this Mintlify port there is only one file that maps to either of those slugs: core/get-started/setup/self-managed/quick-install.mdx, whose slug is /getting-started/quick-start/oss (so it maps to upstream oss.mdx). There is no Mintlify file with slug /install/quick-install. Per the slug-preservation rule, I only ported changes to the file that exists (the OSS quickstart); the quick-install.md content changes (Windows/WSL note, CLI-only flow, removal of the curl tab) are not reflected because the corresponding page doesn't exist on this side. Worth a follow-up to decide whether to add a /install/quick-install page or merge the two intentionally.

  • snippets/_macos.mdx is now unreferenced (matches the upstream choice to leave _macos.md in place). Left as-is.

  • snippets/_quick_install.mdx and snippets/_windows_install.mdx remain unreferenced, same as upstream.

  • The upstream src/components/Install/Install.js (custom React selector) and src/css/custom.scss changes have no Mintlify equivalent — the Mintlify landing page already uses CardGroup/Card, and I restructured that to match the new two-group layout instead.

Context

Source PR: ClickHouse/clickhouse-docs#6334.


Note

Low Risk
Documentation and navigation copy only; no runtime, auth, or data-path changes.

Overview
This PR updates install documentation to favor clickhousectl local use stable (install, set default, and put clickhouse on PATH via ~/.local/bin) instead of local install stable, with a clear use vs install note in the shared CLI snippet and quick-start flows.

Information architecture changes split self-managed setup into Local development (quick install, Docker, source/CI builds) and Production server (Linux packages and NixOS). The main Install and self-managed overview landing pages use matching card groups; macOS and Windows cards are removed from those hubs and from the sidebar in navigation.json (URLs can still exist). The macOS install page now reuses the CLI install snippet instead of the deprecated Homebrew path, and Advanced install is renamed Source & CI builds (slug unchanged).

Reviewed by Cursor Bugbot for commit 2891034. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Jun 3, 2026, 1:00 PM

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.

0 participants