|
18 | 18 |
|
19 | 19 | 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/)
|
20 | 20 |
|
21 |
| -## Table of contents {#table-of-contents} |
| 21 | +## Table of contents |
22 | 22 |
|
23 | 23 | - [About this repo](#about-this-repo)
|
24 | 24 | - [Run locally](#run-locally)
|
25 | 25 | - [Contributing](#contributing)
|
26 | 26 | - [Issues](#issues)
|
27 | 27 | - [License](#license)
|
28 | 28 |
|
29 |
| -## About this repo {#about-this-repo} |
| 29 | +## About this repo |
30 | 30 |
|
31 | 31 | 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.
|
32 | 32 |
|
33 |
| -## Run locally {#run-locally} |
| 33 | +## Run locally |
34 | 34 |
|
35 | 35 | 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.
|
36 | 36 |
|
@@ -116,23 +116,19 @@ To check spelling and markdown is correct locally run:
|
116 | 116 | yarn check-style
|
117 | 117 | ```
|
118 | 118 |
|
119 |
| -### Notes {#notes} |
| 119 | +### Notes |
120 | 120 |
|
121 | 121 | Here are some things to keep in mind when building a local copy of the ClickHouse docs site.
|
122 | 122 |
|
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 |
128 | 124 |
|
129 | 125 | 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`.
|
130 | 126 |
|
131 |
| -## Contributing {#contributing} |
| 127 | +## Contributing |
132 | 128 |
|
133 | 129 | 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).
|
134 | 130 |
|
135 |
| -### Pull requests {#pull-requests} |
| 131 | +### Pull requests |
136 | 132 |
|
137 | 133 | 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.
|
138 | 134 |
|
|
0 commit comments