Skip to content

docs: note Cloud and self-hosted, update the paragraph breaks - #3225

Merged
chernser merged 2 commits into
ClickHouse:mainfrom
mikelewisCH:docs-readme-cloud-and-self-hosted
Oct 19, 2026
Merged

chernser merged 2 commits into
ClickHouse:mainfrom
mikelewisCH:docs-readme-cloud-and-self-hosted

Conversation

@mikelewisCH

Copy link
Copy Markdown
Member

Summary

The README did not say whether the client can be pointed at a hosted ClickHouse or at one you run yourself. This PR adds a sentence to About the Project saying the client and driver work with both, linking a Cloud trial and the self-hosted install guide.

Placing it there needed the opening description broken into paragraphs, which also repairs a rendering fault: trailing whitespace was running the Historically, there are two versions sentence onto the end of the JDBC one. The same sentence had a bare repository URL spelled Clickhouse, now a link, with the ClickHouse site linked alongside it.

Everything is inside the existing About the Project section. No headings were added, so the table of contents is unchanged.

Related: https://linear.app/clickhouse/issue/DOC-1019

Checklist

Documentation only — README.md. No tests apply, and AGENTS.md scopes CHANGELOG.md to user-facing changes.

mikelewisCH and others added 2 commits October 17, 2026 14:59
The README does not say whether the client can be pointed at a hosted
ClickHouse or one you run yourself. Add a sentence to `About the
Project` that says the client and driver work with both, linking a Cloud
trial and the self-hosted install guide.

Also update the paragraph breaks in the opening description, which makes
room for the new sentence. Trailing whitespace had been running the
`Historically, there are two versions` sentence onto the end of the JDBC
one.

Link the ClickHouse repository and site in the first sentence. The
repository URL was bare and spelled `Clickhouse`.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The sentence added in the previous commit had no blank line after it, so
it rendered joined to `Historically, there are two versions` -- the same
fault this branch set out to repair.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mikelewisCH
mikelewisCH marked this pull request as ready for review October 19, 2026 16:06
@chernser
chernser merged commit c95f1d9 into ClickHouse:main Oct 19, 2026
4 checks passed
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