We welcome contributions from the broader ClickHouse community!
If you've discovered something cool about ClickHouse that you want to share with other ClickHouse aficionados, the ClickHouse Knowledge Base is exactly the place to do it.
- Clone the ClickHouse Knowledge Base repo.
- Create a new branch for your tip.
- Write your tip using Markdown formatting; using code blocks with the appropriate language name for any code snippets.
- Save your tip as a .md file in
knowledge-base/docs/{category}choosing the most appropriate category. - Open a pull request to merge your branch; tell us a little bit about your tip in the PR description.
- Maintainers will review & let you know if there's any changes needed.
- Maintainers will ensure appropriate meta data & tags are applied to the tip.
- Maintainers will merge when changes are approved.
If you aren't sure in which category to place your tip, or if you think there should be a new category, feel free to raise an issue to discuss!
- Tips should be practical, not theoretical. People who read your tip should be able to replicate it. Please no tips that explain ClickHouse internals unless they do so by way of showing a query or config example.
- Tips should contribute something over and above the official ClickHouse documentation, either by providing a more detailed explanation of why or how something works the way it does or by giving concrete and specific examples.
- If possible, try to explain why the tip is impactful. Be specific. For example, instead of saying "This will improve performance" say "This will make your joins more efficient and should reduce query response time by 3-4x".
- Please include example query responses if possible.
- If the tip demonstrates a performance improvement (e.g. query time, bytes processed, etc.), include before/after metrics with query responses if possible.
- Please submit tips in English. Don't worry if your grammar or spelling isn't perfect.