Make clickhousectl the recommended local install method, and restructure the Install menu#6334
Make clickhousectl the recommended local install method, and restructure the Install menu#6334sdairs wants to merge 5 commits into
Conversation
Recommend `clickhousectl local use stable` instead of `local install stable` on the getting-started and deployment-modes pages. Explain that `use` installs the version, sets it as the default, and symlinks the clickhouse binary onto PATH - so later docs that call `clickhouse` directly work as-is - while `install` only downloads a version. Switch the macOS install method from the deprecated Homebrew formula to the shared clickhousectl CLI snippet, and drop the Homebrew snippet. Simplify the Quick install page to a single clickhousectl flow (remove the CLI/curl tabs) and add a note that Windows users should use WSL. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…rver Sidebar: group the Install items into Local development (Quick install, Docker, Source & CI builds) and Production server (Debian/Ubuntu, Redhat, Other Linux, NixOS). Drop Windows and macOS from the menu, and rename the former "Advanced install" page to "Source & CI builds" (slug unchanged). Install landing page: mirror the structure in the platform selector - Cloud at the top, then Local development and Production server card groups with a short description of each. Remove the Windows and macOS cards. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
You must have Developer access to commit code to ClickHouse on Vercel. If you contact an administrator and receive Developer access, commit again to see your changes. Learn more: https://vercel.com/docs/accounts/team-members-and-roles/access-roles#team-level-roles |
|
Docs PR opened: ClickHouse/mintlify-docs-dev#113 Updated install docs to recommend clickhousectl local use stable and reorganized the install menu into Local development and Production server groups. Once this PR is merged, we'll do a second pass to capture any additional changes and update the docs PR. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 7078306. Configure here.
Blargian
left a comment
Blargian
left a comment
There was a problem hiding this comment.
Pushed a few small changes, LGTM
2 participants
Updates the install docs around
clickhousectland reorganizes the Install navigation.What changed
Recommend
clickhousectl local use stable(overlocal install stable) on the install, quick-start, and deployment-modes pages.useinstalls the version, sets it as the default, and creates theclickhousesymlink onPATH;installonly downloads a version. We call this out so later docs that runclickhousedirectly work as-is for anyone who followed the quick start.Unify local installation around the ClickHouse CLI. The Quick install page is now a single, opinionated clickhousectl flow (removed the CLI/curl tabs), with a note that Windows users should use WSL.
Drop the deprecated Homebrew formula for macOS. macOS now points at the shared clickhousectl CLI snippet; removed the Homebrew snippet.
Restructure the Install menu and landing page into two clearer groups:
The landing-page selector mirrors this: Cloud at the top, then the two groups with a short description of each. Windows and macOS cards/menu entries are dropped (the pages remain reachable by URL).
Why
Most people hitting these pages want a working local ClickHouse fast. Pushing
clickhousectlas the one recommended path — and making the symlink behavior explicit — keeps the local flow short and consistent, while the menu split separates "try it locally" from "run a server."Notes
_quick_install.md(curl-script snippet) is now unreferenced but left in place.🤖 Generated with Claude Code
Note
Low Risk
Documentation, sidebar, install UI, and URL redirects only; no runtime or security-sensitive code changes.
Overview
This PR repositions local ClickHouse setup around
clickhousectl local useinstead oflocal installon install, quick-start, and deployment-modes pages, and documents thatusesets the default version and puts aclickhousesymlink onPATH(with a note thatinstallonly downloads).Quick install is now a single CLI flow: the CLI/curl tabs and the curl snippet import are removed, and Windows users are directed to WSL. The deprecated Homebrew/macOS install snippet is deleted; dedicated macOS/Windows wrapper pages are emptied and dropped from the nav (permanent redirects to quick install in
vercel.json).Install IA splits into Local development (quick install, Docker, renamed Source & CI builds) and Production server (Debian/Ubuntu, Redhat, NixOS, other Linux). The install landing
InstallSelectormirrors that with grouped cards (no macOS/Windows tiles), embeds advanced as “Source build,” and adds install UI/CSS plus a logo mark asset.Risk: English-only in this diff; i18n copies still reference old commands and nav unless updated separately.
Reviewed by Cursor Bugbot for commit 986e8de. Bugbot is set up for automated code reviews on this repo. Configure here.