Skip to content

Commit 5e2946a

Browse files
authored
Merge branch 'main' into update_clusters_tutorial
2 parents a858c59 + fe08d0b commit 5e2946a

File tree

142 files changed

+4471
-1114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+4471
-1114
lines changed

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,15 @@ static/knowledgebase_toc.json
5555
.frontmatter-validation-failed
5656
logs/
5757

58+
# Landing page files with autogenerated table of contents
59+
docs/cloud/reference/release-notes-index.md
60+
docs/cloud/manage/api/api-reference-index.md
61+
docs/getting-started/index.md
62+
docs/data-modeling/projections/index.md
63+
docs/cloud/manage/jan2025_faq/index.md
64+
docs/chdb/guides/index.md
65+
docs/use-cases/AI_ML/index.md
66+
5867
.vscode
5968
.aspell.en.prepl
6069
*.md.bak
@@ -69,3 +78,4 @@ docs/whats-new/changelog/index.md
6978
docs/cloud/manage/api/api-reference-index.md
7079
docs/getting-started/index.md
7180
docs/data-modeling/projections/index.md
81+
docs/integrations/data-ingestion/clickpipes/kafka/index.md

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align=center>
22

3-
![Website](https://img.shields.io/website?up_message=AVAILABLE&down_message=DOWN&url=https%3A%2F%2Fclickhouse.com%2Fdocs&style=for-the-badge)
3+
[![Website](https://img.shields.io/website?up_message=AVAILABLE&down_message=DOWN&url=https%3A%2F%2Fclickhouse.com%2Fdocs&style=for-the-badge)](https://clickhouse.com)
44
[![CC BY-NC-SA 4.0 License](https://img.shields.io/badge/license-CC-blueviolet?style=for-the-badge)](http://creativecommons.org/licenses/by-nc-sa/4.0/)
55
![Checks](https://img.shields.io/github/actions/workflow/status/clickhouse/clickhouse-docs/debug.yml?style=for-the-badge&label=Checks)
66

@@ -18,19 +18,19 @@
1818

1919
ClickHouse is blazing fast, but understanding ClickHouse and using it effectively is a journey. The documentation is your source for gaining the knowledge you need to be successful with your ClickHouse projects and applications. [Head over to clickhouse.com/docs to learn more →](https://clickhouse.com/)
2020

21-
## Table of contents {#table-of-contents}
21+
## Table of contents
2222

2323
- [About this repo](#about-this-repo)
2424
- [Run locally](#run-locally)
2525
- [Contributing](#contributing)
2626
- [Issues](#issues)
2727
- [License](#license)
2828

29-
## About this repo {#about-this-repo}
29+
## About this repo
3030

3131
This repository manages the documentation for [ClickHouse](https://clickhouse.com/docs). The content is built with [Docusaurus](https://docusaurus.io/) and hosted on [Vercel](https://vercel.com). Documentation content is written in Markdown and is held in the `/docs` directory.
3232

33-
## Run locally {#run-locally}
33+
## Run locally
3434

3535
You can run a copy of this website locally within a few steps. Some folks find this useful when contributing so they can see precisely what their changes will look like on the production site.
3636

@@ -116,23 +116,19 @@ To check spelling and markdown is correct locally run:
116116
yarn check-style
117117
```
118118
119-
### Notes {#notes}
119+
### Notes
120120
121121
Here are some things to keep in mind when building a local copy of the ClickHouse docs site.
122122
123-
#### Build-time {#build-time}
124-
125-
Due to the complex structure of this repo, the docs site can take some time to build locally. As a benchmark, it takes ~3 minutes to build on an M1 Macbook with 8GB RAM.
126-
127-
#### Redirects {#redirects}
123+
#### Redirects
128124
129125
Due to how the local server is built, redirects will not work. For example, visiting `clickhouse.com/docs` on the production site will lead you to `clickhouse.com/docs/intro`. However, on a local copy of the site, you will see a 404 page if you try to visit `localhost:8000/docs`.
130126
131-
## Contributing {#contributing}
127+
## Contributing
132128
133129
Want to help out? Contributions are always welcome! If you want to help out but aren't sure where to start, check out the [issues board](https://github.com/clickhouse/clickhouse-docs/issues).
134130

135-
### Pull requests {#pull-requests}
131+
### Pull requests
136132

137133
Please assign any pull request (PR) against an issue; this helps the docs team track who is working on what and what each PR is meant to address. If there isn't an issue for the specific _thing_ you want to work on, quickly create one and comment so that it can be assigned to you. One of the repository maintainers will add you as an assignee.
138134

docs/about-us/beta-and-experimental-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The sections below explicitly describe the properties of **Beta** and **Experime
2222
- Possibly enabled in ClickHouse Cloud
2323
- The ClickHouse team supports beta features
2424

25-
The following features are considered Beta in ClickHouse Cloud and are available for use in ClickHouse Cloud Services, even though they may be currently under a ClickHouse SETTING named ```allow_experimental_*```:
25+
You can find below the features considered Beta in ClickHouse Cloud and are available for use in your ClickHouse Cloud Services.
2626

2727
Note: please be sure to be using a current version of the ClickHouse [compatibility](/operations/settings/settings#compatibility) setting to be using a recently introduced feature.
2828

docs/chdb/guides/index.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,5 @@ from YAML frontmatter fields title, slug, description. If you've found an error
1313
in the table of contents, please edit the frontmatter of the files directly.
1414
-->
1515

16-
| Page | Description |
17-
|-----|-----|
18-
| [How to query Parquet files](/chdb/guides/querying-parquet) | Learn how to query Parquet files with chDB. |
19-
| [How to query data in an S3 bucket](/chdb/guides/querying-s3) | Learn how to query data in an S3 bucket with chDB. |
20-
| [Using a clickhouse-local database](/chdb/guides/clickhouse-local) | Learn how to use a clickhouse-local database with chDB |
21-
| [How to query Pandas DataFrames with chDB](/chdb/guides/pandas) | Learn how to query Pandas DataFrames with chDB |
22-
| [JupySQL and chDB](/chdb/guides/jupysql) | How to install chDB for Bun |
23-
| [How to query a remote ClickHouse server](/chdb/guides/query-remote-clickhouse) | In this guide, we'll learn how to query a remote ClickHouse server from chDB. |
24-
| [How to query Apache Arrow with chDB](/chdb/guides/apache-arrow) | In this guide, we'll learn how to query Apache Arrow tables with chDB |
16+
<!--AUTOGENERATED_START-->
17+
<!--AUTOGENERATED_END-->

docs/cloud/changelogs/fast-release-24-2.md renamed to docs/cloud/changelogs/24_02.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ slug: /whats-new/changelog/24.2-fast-release
33
title: 'v24.2 Changelog'
44
description: 'Fast release changelog for v24.2'
55
keywords: ['changelog']
6-
sidebar_label: 'v24.2'
6+
sidebar_label: '24.2'
7+
sidebar_position: 8
78
---
89

910
### ClickHouse release tag: 24.2.2.15987 {#clickhouse-release-tag-242215987}

docs/cloud/changelogs/changelog-24-5.md renamed to docs/cloud/changelogs/24_05.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ slug: /changelogs/24.5
33
title: 'v24.5 Changelog for Cloud'
44
description: 'Fast release changelog for v24.5'
55
keywords: ['changelog', 'cloud']
6-
sidebar_label: 'v24.5'
6+
sidebar_label: '24.5'
7+
sidebar_position: 7
78
---
89

910
# v24.5 Changelog for Cloud

docs/cloud/changelogs/changelog-24-6.md renamed to docs/cloud/changelogs/24_06.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ slug: /changelogs/24.6
33
title: 'v24.6 Changelog for Cloud'
44
description: 'Fast release changelog for v24.6'
55
keywords: ['changelog', 'cloud']
6-
sidebar_label: 'v24.6'
6+
sidebar_label: '24.6'
7+
sidebar_position: 6
78
---
89

910
# v24.6 Changelog for Cloud

docs/cloud/changelogs/changelog-24-8.md renamed to docs/cloud/changelogs/24_08.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ slug: /changelogs/24.8
33
title: 'v24.8 Changelog for Cloud'
44
description: 'Fast release changelog for v24.8'
55
keywords: ['changelog', 'cloud']
6-
sidebar_label: 'v24.8'
6+
sidebar_label: '24.8'
7+
sidebar_position: 5
78
---
89

910
Relevant changes for ClickHouse Cloud services based on the v24.8 release.

docs/cloud/changelogs/changelog-24-10.md renamed to docs/cloud/changelogs/24_10.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ slug: /changelogs/24.10
33
title: 'v24.10 Changelog for Cloud'
44
description: 'Fast release changelog for v24.10'
55
keywords: ['changelog', 'cloud']
6-
sidebar_label: 'v24.10'
6+
sidebar_label: '24.10'
7+
sidebar_position: 4
78
---
89

910
Relevant changes for ClickHouse Cloud services based on the v24.10 release.

docs/cloud/changelogs/changelog-24-12.md renamed to docs/cloud/changelogs/24_12.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ slug: /changelogs/24.12
33
title: 'v24.12 Changelog for Cloud'
44
description: 'Fast release changelog for v24.12'
55
keywords: ['changelog', 'cloud']
6-
sidebar_label: 'v24.12'
6+
sidebar_label: '24.12'
7+
sidebar_position: 3
78
---
89

910
Relevant changes for ClickHouse Cloud services based on the v24.12 release.

0 commit comments

Comments
 (0)