docs: port clickhousectl install updates and restructure install nav#113
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: port clickhousectl install updates and restructure install nav#113mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Summary
Ports ClickHouse/clickhouse-docs#6334 — recommend
clickhousectl local use stablefor local installs and restructure the Install menu/landing page into Local development and Production server groups.Changes
snippets/_cli_install.mdx— recommendclickhousectl local use stableand add the "Use vs install" note.core/get-started/about/deployment-modes.mdx— switch the example tolocal 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.mdwith slug/install/quick-installdocs/getting-started/quick-start/oss.mdxwith slug/getting-started/quick-start/ossIn 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 upstreamoss.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); thequick-install.mdcontent 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-installpage or merge the two intentionally.snippets/_macos.mdxis now unreferenced (matches the upstream choice to leave_macos.mdin place). Left as-is.snippets/_quick_install.mdxandsnippets/_windows_install.mdxremain unreferenced, same as upstream.The upstream
src/components/Install/Install.js(custom React selector) andsrc/css/custom.scsschanges have no Mintlify equivalent — the Mintlify landing page already usesCardGroup/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 putclickhouseonPATHvia~/.local/bin) instead oflocal 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.