Repository files navigation

ClickHouse® is an open-source column-oriented database management system that allows generating analytical data reports in real-time.

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 →

• About this repo
• Run locally
• Contributing
• Issues
• License

This repository manages the documentation forClickHouse. The content is built withDocusaurus and hosted onVercel. Documentation content is written in Markdown and is held in the/docs directory.

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.

1. Install Git and npm. If you already have them installed, skip this step:

   OS	Package manager	Install command
   macOS	Homebrew	brew install git node
   Ubuntu	Apt	sudo apt install git nodejs npm
   Arch	Pacman	sudo pacman -S git nodejs npm
   Windows	Chocolatey	choco install git nodejs-lts

2. Installyarn. If you already have it installed, skip this step:

   sudo npm install --global yarn

3. Clone this repository and move into theclickhouse-docs directory:

   git clone https://github.com/clickhouse/clickhouse-docscd clickhouse-docs

4. Install the project dependencies with Yarn:

   yarn install# yarn install v1.22.19# [1/5] 🔍  Validating package.json...# [2/5] 🔍  Resolving packages...# ...# success Saved lockfile.# ✨  Done in 6.44s.

5. Use Yarn to grab the latest documentation changes from theClickHouse/ClickHouse repository and build the documentation usingyarn-build:

   yarn build# Cloning into 'ClickHouse'...# ...# [SUCCESS] Generated static files in "build".# [INFO] Use `npm run serve` command to test your build locally.# ✨  Done in 105.96s.

1. Start the local web-server:

   yarn start# yarn run v1.22.19# $ docusaurus start# ...#

   This command will build the documentation site and serve it locally. Once the build has finished, browse the website atlocalhost:3000.

2. To stop the local server, pressctrl +c in the terminal window.

If you want to build a static copy of this repository that doesn't require a constant server running to view, you can useyarn build instead ofyarn start. Theyarn build will output a static copy of the website in the/build directory. This process takes around 10 minutes to complete on an M1 Macbook with 8GB RAM.

1. Should you wish to make changes to documents which are located in the ClickHouse/ClickHouse repo and want to visualize what the changes made look like locally you can useyarn copy-clickhouse-repo-docs -l and provide a path to the ClickHouse repository on your local machine, for example:

   # yarn copy-clickhouse-repo-docs -l /Users/user/Desktop/ClickHouse# Successfully executed local copy# ✨  Done in 1.15s.

We recommend to install rsync in order to only copy what is needed, however the script will fallback to usingcp if rsync is not available.

Runningyarn copy-clickhouse-repo-docs without any arguments will pull in the latest docs changes from github.

To check spelling and markdown is correct locally run:

yarn check-style

Here are some things to keep in mind when building a local copy of the ClickHouse docs site.

Due to how the local server is built, redirects will not work. For example, visitingclickhouse.com/docs on the production site will lead you toclickhouse.com/docs/intro. However, on a local copy of the site, you will see a 404 page if you try to visitlocalhost:8000/docs.

Want to help out? Contributions are always welcome! If you want to help out but aren't sure where to start, check out theissues board.

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 specificthing 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.

Check out the GitHub docs for a refresher onhow to create a pull request.

For documentation style guidelines, see"Style guide".

To check spelling and markdown is correct locally run:

yarn check-style

For an overview of how reference documentation such as settings, system tablesand functions are generated from the source code, see"Generating documentation from source code"

There are five workflows that run against PRs in this repo:

Have you noticed a typo or found some wonky formatting? For small contributions like these, it's usually faster and easier to make your changes directly in GitHub. Here's a quick guide to show you how the GitHub editor works:

1. Each page in Clickhouse.com/docs has anEdit this page link at the top:

   

   Click this button to edit this page in GitHub.

2. Once you're in GitHub, click the pencil icon to edit this page:

   

3. GitHub willfork the repository for you. This creates a copy of theclickhouse-docs repository on your personal GitHub account.

4. Make your changes in the textbox. Once you're done, clickCommit changes:

   

5. In thePropose changes popup, enter a descriptive title to explain the changes you just made. Keep this title to 10 words or less. If your changes are fairly complex and need further explanation, enter your comments into theExtended description field.

6. Make sureCreate a new branch is selected, and clickPropose changes:

   

7. A new page should open with a new pull request. Double-check that the title and description are accurate.

8. If you've spoken to someone on the docs team about your changes, tag them into theReviewers section:

   

   If you haven't mentioned your changes to anyone yet, leave theReviewers section blank.

9. ClickCreate pull request.

At this point, your pull request will be handed over to the docs team, who will review it and suggest or make changes where necessary.

Found a problem with the Clickhouse docs site?Please raise an issue. Be as specific and descriptive as possible; screenshots help!

This work is licensed under aCreative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.