Skip to content

Restore curl Quick install; move clickhousectl to its own page#6343

Merged
Blargian merged 4 commits into
mainfrom
install-restore-curl-quick-install
Jun 4, 2026
Merged

Restore curl Quick install; move clickhousectl to its own page#6343
Blargian merged 4 commits into
mainfrom
install-restore-curl-quick-install

Conversation

@sdairs
Copy link
Copy Markdown
Contributor

@sdairs sdairs commented Jun 4, 2026

What & why

Yesterday's #… ("Make clickhousectl the recommended local install method") replaced the curl-based Quick install flow with clickhousectl. This brings back the original curl steps as Quick install and gives clickhousectl its own page, so both local-development methods are documented side by side.

Changes

  • Quick install (/install/quick-install) renders the curl flow again via the _quick_install.md snippet.
  • New page clickhousectl.md (/install/clickhousectl, sidebar label clickhousectl (CLI)) renders the _cli_install.md snippet, placed directly below Quick install in the Local development sidebar group.
  • Install page cards (install.mdx / Install.js): Quick install now shows the curl steps; added a new clickhousectl (CLI) card (console icon) showing the clickhousectl steps.
  • Cloud CLI page: repointed the "Local development" link to /install/clickhousectl (it's specifically about the CLI managing local installs).
  • Docs home → Connect to ClickHouse: renamed the button from ClickHouse CLIClickHouse Client and pointed it at /interfaces/client instead of /interfaces/cli (which is clickhousectl). i18n keys updated to match (en/jp/ko/ru/zh).
  • Dropped the ~/.local/bin PATH note from the curl snippet.

Both dedicated pages and both install-page cards share the _quick_install.md and _cli_install.md snippets as single sources of truth.

Validation

Ran the Docusaurus dev server — /docs/install, /docs/install/quick-install, /docs/install/clickhousectl, /docs/, and /docs/interfaces/client all compile and serve cleanly (Rspack compiled successfully, no errors).

🤖 Generated with Claude Code


Note

Low Risk
Documentation, navigation, and i18n string/link updates only; no runtime or application code changes.

Overview
Restores curl-based Quick install as its own flow and adds a dedicated /install/clickhousectl page so local setup is documented as two parallel paths instead of one replacing the other.

The main Install hub (EN + JP/KO/RU/ZH) drops the interactive InstallSelector in favor of linked cards for Local development (Quick install, clickhousectl, Docker, source) and Production server (distro/Linux links). Install.js is removed; the sidebar gains clickhousectl under Local development.

Quick install again imports only _quick_install.md (curl script); the curl snippet no longer mentions adding ~/.local/bin to PATH. Cloud CLI docs point local-dev readers to /install/clickhousectl.

The docs homepage Connect CTA is renamed to ClickHouse Client and targets /docs/interfaces/client (not clickhousectl); i18n keys follow (clickhouseCliclickhouseClient).

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

Yesterday's "Make clickhousectl the recommended local install method"
change replaced the curl-based Quick install flow with clickhousectl.
This restores curl as the Quick install page and gives clickhousectl its
own page, so both methods are documented side by side.

- quick-install.md (/install/quick-install) now renders the curl flow
  via the _quick_install.md snippet.
- New clickhousectl.md (/install/clickhousectl, label "clickhousectl
  (CLI)") renders the _cli_install.md snippet, sitting directly below
  Quick install in the Local development sidebar group.
- install.mdx Local development cards: Quick install now shows the curl
  steps and a new "clickhousectl (CLI)" card (console icon) shows the
  clickhousectl steps.
- Repoint the cloud CLI page's local-development link to
  /install/clickhousectl (it's specifically about the CLI managing local
  installs).
- Docs home "Connect to ClickHouse": rename the button from "ClickHouse
  CLI" -> "ClickHouse Client" and point it at /interfaces/client instead
  of /interfaces/cli (which is clickhousectl). Updated i18n keys to match.
- Drop the PATH note from the curl snippet.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sdairs sdairs requested a review from a team as a code owner June 4, 2026 12:10
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 4, 2026

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

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ 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 c7fc0c9. Configure here.

Comment thread src/components/Install/Install.js Outdated
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 4, 2026

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

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview Jun 4, 2026 3:07pm
clickhouse-docs-ko Error Error Jun 4, 2026 3:07pm
clickhouse-docs-ru Error Error Jun 4, 2026 3:07pm
clickhouse-docs-zh Ready Ready Preview, Comment Jun 4, 2026 3:07pm

Request Review

sdairs and others added 2 commits June 4, 2026 14:00
Drop the 60ch max-width on .install-group-description so the Local
development and Production server paragraphs wrap at the full content
width like the intro paragraph, instead of breaking early and looking
like manual line breaks.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove the stateful InstallSelector component from the install page in
favor of plain cards that link directly to each install method's
dedicated page. Localize the card grid in the ru/zh/ko/jp i18n copies,
delete the now-unused component, and fix the clickhousectl admonition
title syntax.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 4, 2026

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

Restored the curl-based Quick install flow and added a dedicated clickhousectl install page so both local-development methods are documented.

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.

2 participants