Skip to content

Docs: own and sync ClickHouse documentation#2945

Merged
chernser merged 1 commit into
ClickHouse:mainfrom
Blargian:agent/own-clickhouse-docs
Jul 24, 2026
Merged

Docs: own and sync ClickHouse documentation#2945
chernser merged 1 commit into
ClickHouse:mainfrom
Blargian:agent/own-clickhouse-docs

Conversation

@Blargian

Copy link
Copy Markdown
Member

Summary

Make ClickHouse/clickhouse-java the source of truth for its public ClickHouse documentation.

  • Copy the current Java documentation slice from ClickHouse/ClickHouse@21ed77718a5f454680497924d68e9f60a41e026c into docs/clickhouse-docs/, with trailing whitespace normalized. The dedicated subdirectory keeps repository-only engineering docs out of the published slice.
  • Add a scoped Mintlify verification workflow for changes to that slice.
  • Add a one-way sync workflow that opens or refreshes the corresponding ClickHouse/ClickHouse docs PR after a release, manual dispatch, or merge carrying the sync-docs label.

The published URLs and aggregator path remain unchanged. This does not change the Java API or runtime behavior.

After merge, maintainers should confirm the sync-docs label exists and the Workflow Auth GitHub App credentials are available to this repository.

Validation

  • All workflows pass actionlint v1.7.7 and YAML parsing.
  • git diff --check passes.
  • The migrated slice matches the current aggregator source after trailing-whitespace normalization.
  • Compatibility impact: none; documentation and CI only.

@Blargian Blargian changed the title Own and sync ClickHouse documentation Docs: own and sync ClickHouse documentation Jul 21, 2026
@Blargian
Blargian marked this pull request as ready for review July 22, 2026 09:20
@Blargian
Blargian requested a review from mzitnik as a code owner July 22, 2026 09:20
@Blargian

Copy link
Copy Markdown
Member Author

@chernser assuming the two failing checks here are unrelated to this change?

@cursor cursor Bot left a comment

Copy link
Copy Markdown

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 high effort and found 3 potential issues.

Fix All in Cursor

Reviewed by Cursor Bugbot for commit 592e8d1. Configure here.

Comment thread .github/workflows/docs_sync.yml
Comment thread .github/workflows/docs_sync.yml
Comment thread .github/workflows/docs_sync.yml
@chernser
chernser merged commit cc57099 into ClickHouse:main Jul 24, 2026
30 of 33 checks passed
@chernser

Copy link
Copy Markdown
Contributor

thank you @Blargian !
Yes, this checks are not related and should be already fixed on main

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