docs: port clickhousectl local use + restructure Install IA#122
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: port clickhousectl local use + restructure Install IA#122mintlify[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: makes
clickhousectl local use stablethe recommended local install command and restructures the Install IA into Local development and Production server groups.Changes
snippets/_cli_install.mdx— switched the install step fromlocal install stabletolocal use stable; added the symlink/PATH explanation and a "Use vs install" callout.core/get-started/setup/self-managed/quick-install.mdx(slug/getting-started/quick-start/oss) — updated the OSS quick start to recommendlocal use stable, explain the symlink behavior, and added an "Advanced: install ClickHouse withoutclickhousectl" accordion with theCLICKHOUSE_ONLY=1one-liner.core/get-started/about/deployment-modes.mdx— updated the CLI snippet to uselocal use stableand noted the symlink behavior.core/get-started/setup/self-managed/advanced.mdx— renamed sidebarTitle/title from "Advanced install" to Source & CI builds (slug/install/advancedunchanged).core/get-started/setup/install.mdx(Install landing) — split into a Cloud/Migrate row + Local development group (Quick install, Docker, Source & CI builds) + Production server group (Debian/Ubuntu, RHEL, Other Linux, NixOS). macOS and Windows cards dropped.core/get-started/setup/self-managed/overview.mdx— mirrored the same Local development / Production server grouping; dropped macOS and Windows cards.core/get-started/navigation.json— Self-managed section now nests two subgroups (Local development / Production server).macosandwindowsremoved from the nav. The pages remain reachable by URL (/install/macOS,/install/windows).Context
Source PR: ClickHouse/clickhouse-docs#6334 — "Make clickhousectl the recommended local install method, and restructure the Install menu". Two source commits: content, then navigation.
Notes / ambiguities
quick-install.md(slug/install/quick-install, opinionated CLI flow) andoss.mdx(slug/getting-started/quick-start/oss, full quick-start with tables/queries). The Mintlify repo only has one file atcore/get-started/setup/self-managed/quick-install.mdx, and that file already uses theossslug. I treated this file as the OSS quick start (matching its existing slug) and applied theoss.mdxchanges (CLI install snippet +local use stable+ WSL note + advanced accordion). There is no Mintlify file backing the Docusaurusquick-install.mdslug; if a separate page is desired, that would need a follow-up._macos.mdHomebrew snippet was deleted upstream. The Mintlify equivalentsnippets/_macos.mdxis still referenced fromcore/get-started/setup/self-managed/macos.mdx(which is no longer in the nav but reachable by URL). I left both files in place so the URL keeps working — the snippet already contains a Homebrew deprecation warning pointing at quick-install./install/macOS→/install/quick-install,/install/windows→/install/quick-install) invercel.json. In Mintlify the original slugs are still live pages, so no redirect was added. If the desire is to also redirect them in Mintlify, that needs_site/redirects.jsonentries — flagging here.🤖 Generated with Claude Code
Note
Low Risk
Documentation and navigation-only changes with no runtime or security impact; macOS/Windows pages are still reachable by URL but no longer linked from the install menu.
Overview
Recommends
clickhousectl local use stable(instead oflocal install stable) across shared CLI snippets, the OSS quick start, and deployment modes, with new copy on default version selection and theclickhousesymlink in~/.local/bin, plus a use vs install note and an accordion forCLICKHOUSE_ONLY=1installs without the CLI.Install navigation and landings are split into Local development (quick install, Docker, source/CI) and Production server (Linux distro packages, NixOS). macOS and Windows are dropped from cards and
navigation.json(pages remain at their URLs). The advanced install page is renamed to Source & CI builds.Reviewed by Cursor Bugbot for commit 10dbb68. Bugbot is set up for automated code reviews on this repo. Configure here.