Skip to content

Commit a6b8644

Browse files
BlargianBlargian
authored
Merge branch 'main' into custom_rule_images
2 parents 9999d51 + 3a6c425 commit a6b8644

File tree

32 files changed

+527
-31
lines changed

32 files changed

+527
-31
lines changed

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ Please assign any pull request (PR) against an issue; this helps the docs team t
132132
133133
Check out the GitHub docs for a refresher on [how to create a pull request](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop).
134134
135+
### Style guidelines
136+
137+
For style guidelines, see ["Style guide"](/contribute/style-guide.md).
138+
135139
### Tests and CI/CD {#tests-and-cicd}
136140
137141
There are five workflows that run against PRs in this repo:

‎contribute/style-guide.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# ClickHouse docs style guide
2+
3+
In this document, you will find a number of style guidelines for writing documentation.
4+
The rules in this guide are intended to assist in helping us to create a high
5+
quality documentation offering on par with the quality of ClickHouse itself.
6+
7+
## YAML front matter
8+
9+
Begin every new markdown document with YAML front-matter:
10+
11+
```markdown
12+
---
13+
title: Using a clickhouse-local database
14+
sidebar_label: Using clickhouse-local database
15+
slug: /chdb/guides/clickhouse-local
16+
description: Learn how to use a clickhouse-local database with chDB
17+
keywords: [chdb, clickhouse-local]
18+
---
19+
```
20+
21+
## Explicit header tags
22+
23+
Due to the way our translation system works, it is necessary to add an explicit
24+
anchor tag next to every header, such as `{#explicit-anchor-tag}`.
25+
26+
For example:
27+
28+
```markdown
29+
## My header {#my-header}
30+
```
31+
32+
### Associated markdown rule or CI check
33+
- [`custom-anchor-headings`](/scripts/.markdownlint-cli2.yaml)
34+
35+
## Images
36+
37+
In all cases images get added to the `static/images` directory of the repository.
38+
Under the images directory you should place the images according to the folder
39+
structure of the docs.
40+
41+
For example, if you wanted to add images to `clickhouse-local.md` which is
42+
located at `/docs/chdb/guides/clickhouse-local.md`. You should add the
43+
images at `/static/images/chdb/guides/`.
44+
45+
Try to use descriptive names in lower case. For example:
46+
- `clickhouse-local-1.png`
47+
- `clickhouse-local-2.png`
48+
- `clickhouse-local-3.png` etc.
49+
50+
In the markdown document import the images under the YAML frontmatter:
51+
52+
```markdown
53+
---
54+
title: Using a clickhouse-local database
55+
sidebar_label: Using clickhouse-local database
56+
slug: /chdb/guides/clickhouse-local
57+
description: Learn how to use a clickhouse-local database with chDB
58+
keywords: [chdb, clickhouse-local]
59+
---
60+
61+
import clickhouse-local-1 from '@site/static/images/chdb/guides/clickhouse-local-1.png'
62+
import clickhouse-local-2 from '@site/static/images/chdb/guides/clickhouse-local-2.png'
63+
import clickhouse-local-3 from '@site/static/images/chdb/guides/clickhouse-local-3.png'
64+
```
65+
66+
Use the `<img/>` tag to place your image in the appropriate place:
67+
68+
```markdown
69+
Here is some example text which refers to the image below:
70+
71+
<img src={clickhouse-local-1}
72+
alt='DESCRIPTION OF THE IMAGE'
73+
style={{width: '800px'}} // optional
74+
/>
75+
76+
Here is another paragraph...
77+
```
78+
79+
## Codeblocks
80+
81+
Codeblocks are defined using backticks. For example:
82+
83+
```text
84+
\```sql title='Query'
85+
SELECT * FROM system.contributors;
86+
\```
87+
```
88+
89+
Code blocks:
90+
- Should always have a language defined immediately next to the opening 3
91+
backticks, without any space.
92+
- Have a title (optional) such as 'Query' or 'Response'
93+
- Use language `response` if it is for the result of a query.
94+
95+
### Associated markdown rule or CI check
96+
97+
- [`MD040` enforces that codeblocks have a language specified](/scripts/.markdownlint-cli2.yaml)
98+
99+
## Broken links
100+
101+
Making a change to a page slug or moving a file can result in broken links in
102+
numerous places across the docs. To mitigate this we use the built in link checker
103+
provided by Docusaurus. If broken links are found then docs check will fail with
104+
an error message something like this:
105+
106+
```text
107+
Exhaustive list of all broken links found:
108+
109+
- Broken link on source page path = /docs/observability/integrating-opentelemetry:
110+
-> linking to /docs/observability/schema-design#using-maps
111+
- Broken link on source page path = /docs/operations/server-configuration-parameters/settings:
112+
-> linking to ../../../engines/table-engines/mergetree-family/mergetree#mergetree-table-ttl (resolved as: /engines/table-engines/mergetree-family/mergetree#mergetree-table-ttl)
113+
- Broken link on source page path = /docs/partitions:
114+
-> linking to /docs/optimize/sparse-primary-indexes#data-is-organized-into-granules-for-parallel-data-processing
115+
```
116+
117+
To fix the links, find the source page, given after `source page path =` and search within it for the
118+
link given after `linking to`. As slugs are resolved relative to `/docs` you can exclude this from your
119+
search. E.g don't search `/docs/observability/schema-design#using-maps` but `/observability/schema-design#using-maps`
120+
121+
**note** if you can't find the link on the page but you're sure that you are looking in the file
122+
reported by the failing broken link checker, the link is most likely found in a snippet which is
123+
imported by that page. Find the snippet location from the import statement at the top of the page.
124+
125+

‎docs/about-us/adopters.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ The following list of companies using ClickHouse and their success stories is as
8181
| [Bonside](https://www.bonside.com/) | FinTech | - | — | — | [Hacker News, July 2023](https://news.ycombinator.com/item?id=36619722) |
8282
| [Botify](https://www.botify.com/) | SaaS | SEO | — | — | [Blog Article, September 2022](https://tech.marksblogg.com/billion-taxi-rides-doublecloud-clickhouse.html) |
8383
| [Braintrust](https://www.usebraintrust.com/) | Software & Technology | Real-time Analytics | — | — | [Written Blog from Meetup Video, July 2024](https://clickhouse.com/blog/building-better-ai-products-faster-how-braintrust-uses-clickhouse-for-real-time-data-analysis) |
84+
| [Buildkite](https://buildkite.com/)| Software & Technology | Real-time analytics | — | — | [Wellington meetup, February 2025](https://clickhouse.com/videos/wellington-meetup-buildkite-clickhouse-test-analytics) |
8485
| [ByConity](https://byconity.github.io/)| Software & Technology | Big Data Analysis Engine | — | — | [GitHub](https://github.com/ByConity/ByConity) |
8586
| [Bytedance](https://www.bytedance.com) | Social platforms | — | — | — | [The ClickHouse Meetup East, October 2020](https://www.youtube.com/watch?v=ckChUkC3Pns) |
8687
| [CARTO](https://carto.com/) | Business Intelligence | Geo analytics | — | — | [Geospatial processing with ClickHouse](https://carto.com/blog/geospatial-processing-with-clickhouse/) |
@@ -106,6 +107,7 @@ The following list of companies using ClickHouse and their success stories is as
106107
| [ClickFunnels](https://www.clickfunnels.com/) | Website Builder | | — | — | ClickHouse Cloud user |
107108
| [ClickVisual](https://clickvisual.net/) | Software | Logging Platform | — | — | [Blog Post, May 2022](https://golangexample.com/a-light-weight-log-visual-analytic-platform-for-clickhouse/) |
108109
| [Clog](https://www.hybridlogic.co.uk/) | Software & Technology | Logging | — | — | [Blog, February 2023](https://www.hybridlogic.co.uk/2023/02/clog/) |
110+
| [Cloud Circus, Inc.](https://cloudcircus.jp/) | Software & Technology | Logging | — | — | [Tokyo Meetup, January 2025](https://clickhouse.com/videos/tokyo-meetup-cloudcircus-accelerating-cloudfront-log-analysis) |
109111
| [Cloudflare](https://cloudflare.com) | CDN | Traffic analysis | 36 servers | — | [Blog post, May 2017](https://blog.cloudflare.com/how-cloudflare-analyzes-1m-dns-queries-per-second/), [Blog post, March 2018](https://blog.cloudflare.com/http-analytics-for-6m-requests-per-second-using-clickhouse/) |
110112
| [CloudRaft](https://www.cloudraft.io/) | Software & Technology | Consulting Services | — | — | [Twitter, May 2024](https://x.com/anjuls/status/1792048331805606156) |
111113
| [Codegiant](https://codegiant.io/) | Security | Main product | — | — | [Blog, December 2023](https://blog.codegiant.io/clickhouse-in-codegiant-observability-ecosystem/) |
@@ -219,6 +221,7 @@ The following list of companies using ClickHouse and their success stories is as
219221
| [Hookdeck](https://hookdeck.com/) | Software & Technology | Webhook | — | — | [Twitter, June 2023](https://twitter.com/mkherlakian/status/1666214460824997889) |
220222
| [Hopsteiner](https://www.hopsteiner.com/) | Agriculture | - | — | — | [Job post, July 2023](https://www.indeed.com/viewjob?t=Systems+Administrator&c=S+S+STEINER&l=Yakima,+WA&jk=5b9b7336de0577d5&rtk=1h45ruu32j30q800&from=rss) |
221223
| [Horizon](https://horizon.io/)| Software & Technology | Gaming Analytics | — | — | [Twitter, July 2023](https://twitter.com/peterk/status/1677099027110805504) |
224+
| [Huawei](https://www.huaweicloud.com/intl/en-us/) | Software & Technology | Cloud data platform | — | — | [Documentation](https://doc.hcs.huawei.com/usermanual/mrs/mrs_01_2344.html)
222225
| [Hubalz](https://hubalz.com) | Web analytics | Main product | — | — | [Twitter, July 2023](https://twitter.com/Derinilkcan/status/1676197439152312321) |
223226
| [Huntress](https://www.huntress.com) | Security analytics | Main product | — | — | [Blog Post, November 2024](https://clickhouse.com/blog/how-huntress-improved-performance-and-slashed-costs-with-clickHouse) |
224227
| [Hydrolix](https://www.hydrolix.io/) | Cloud data platform | Main product | — | — | [Documentation](https://docs.hydrolix.io/guide/query) |
@@ -254,6 +257,7 @@ The following list of companies using ClickHouse and their success stories is as
254257
| [KMK Online](https://www.kmkonline.co.id/) | Digital Services | Streaming analytics | — | — | ClickHouse Cloud user |
255258
| [Kaiko](https://www.kaiko.com/) | Digital Assets Data Provider | — | — | — | [Job advertisement, April 2022](https://kaiko.talentlyft.com/) |
256259
| [Kakaocorp](https://www.kakaocorp.com/) | Internet company | — | — | — | [if(kakao)2020](https://tv.kakao.com/channel/3693125/cliplink/414129353), [if(kakao)2021](https://if.kakao.com/session/24) |
260+
| [Kami](https://www.kamiapp.com/) | Education, Software & Technology | Real-time Analytics | — | — | [Auckland Meetup, CTO talk, February 2025](https://clickhouse.com/videos/auckland-meetup-kami-ingesting-clickstream-data-into-clickhouse), [Auckland Meetup, Head of Data talk, Feburary 2025](https://clickhouse.com/videos/auckland-meetup-kami-evolution-of-kami-data-infrastructure) |
257261
| [Klaviyo](https://www.klaviyo.com/) | E-Commerce Marketing Automation Platform| — | 128 nodes | — | [Klaviyo Engineering Blog, Jan 2023](https://klaviyo.tech/adaptive-concurrency-control-for-mixed-analytical-workloads-51350439aeec) , [Klaviyo Engineering Blog, July 2023](https://klaviyo.tech/taking-the-first-sip-an-overview-of-klaviyos-segmentation-improvement-project-7db997f36b39) |
258262
| [Knock.app](https://knock.app/) | Software | Notifications management | - | - | [Twitter, 2024](https://twitter.com/cjbell_/status/1759989849577181356)|
259263
| [Kodiak Data](https://www.kodiakdata.com/) | Clouds | Main product | — | — | [Slides in Engish, April 2018](https://github.com/ClickHouse/clickhouse-presentations/blob/master/meetup13/kodiak_data.pdf) |
@@ -267,12 +271,13 @@ The following list of companies using ClickHouse and their success stories is as
267271
| [Langtrace AI](https://www.langtrace.ai/) | Software & Technology | LLM Monitoring | - | - | [Twitter, May 2024](https://x.com/karthikkalyan90/status/1790483625743716703) |
268272
| [Lago](https://www.getlago.com/) | Billing automation | - | — | — | [GitHub Wiki post](https://github.com/getlago/lago/wiki/How-ClickHouse-saved-our-events-engine-problem) |
269273
| [Lagon](https://lagon.app/) | Software Development | Serverless Functions | — | — | [Twitter, 2023](https://twitter.com/tomlienard/status/1702759256909394010) |
270-
| [Last9](https://last9.io/) | Software & Technology | Observability | — | — | [Mumbai Meetup, 2025](https://clickhouse.com/videos/the-telemetry-data-platform-breaking-down-operational-silos) |
274+
| [Last9](https://last9.io/) | Software & Technology | Observability | — | — | [Mumbai Meetup, February 2025](https://clickhouse.com/videos/the-telemetry-data-platform-breaking-down-operational-silos) , [Bangalore Meetup, February 2025](https://clickhouse.com/videos/less-war-more-room-last9) |
271275
| [Laudspeaker](https://laudspeaker.com/) | Software & Technology | Open Source Messaging | — | — | [GitHub](https://github.com/laudspeaker/laudspeaker) |
272276
| [Lawrence Berkeley National Laboratory](https://www.lbl.gov) | Research | Traffic analysis | 5 servers | 55 TiB | [Slides in English, April 2019](https://www.smitasin.com/presentations/2019-04-17_DOE-NSM.pdf) |
273277
| [Lever](https://www.lever.co/) | Talent Management | Recruiting | - | - | [Hacker News post](https://news.ycombinator.com/item?id=29558544) |
274278
| [LifeStreet](https://lifestreet.com/) | Ad network | Main product | 75 servers (3 replicas) | 5.27 PiB | [Blog post in Russian, February 2017](https://habr.com/en/post/322620/) |
275279
| [LimeChat](https://www.limechat.ai/) | Mobile chat | Whatsapp Commerce | - | - | [LinkedIn 2024](https://www.linkedin.com/pulse/scaling-analytics-clickhouse-story-nikhil-gupta-gezcc/)|
280+
| [LINE Digital Frontier](https://ldfcorp.com/ja) | Gaming | Real-time Analytics | - | - | [Tokyo Meetup, January 2025](https://clickhouse.com/videos/tokyo-meetup-line-from-stateles-servers-to-real-time-analytics)|
276281
| [LiteLLM](https://github.com/BerriAI/litellm) | Software | API management | | - | [GitHub](https://github.com/BerriAI/litellm/blob/e7b88c2134a013f527304de29358238a5593f91f/cookbook/misc/clickhouse_insert_logs.py#L4) |
277282
| [Little Red Book (Xiaohongshu)](http://www.xiaohongshu.com/) | Social Media | Data warehouse | — | — | [Presentation, March 2023](https://github.com/ClickHouse/clickhouse-presentations/blob/master/meetup71/LittleRedBook.pdf) |
278283
| [LogfireAI](https://logfire.ai/) | Software & Technology | Monitoring & Observability | — | — | [Twitter, March 2024](https://twitter.com/logfire_ai/status/1765947119200841883) |
@@ -329,6 +334,8 @@ The following list of companies using ClickHouse and their success stories is as
329334
| [Ntop](https://www.ntop.org/) | Network Monitoning | Monitoring | — | — | [Official website, January 2022](https://www.ntop.org/ntop/historical-traffic-analysis-at-scale-using-clickhouse-with-ntopng/) |
330335
| [Nuna Inc.](https://www.nuna.com/) | Health Data Analytics | — | — | — | [Talk in English, July 2020](https://youtu.be/GMiXCMFDMow?t=170) |
331336
| [Nutanix](https://www.nutanix.com/) | Software & Technology | Main Product | — | — | [Slides, March 2024](https://github.com/ClickHouse/clickhouse-presentations/blob/master/2024-meetup-bengaluru/2-Unified_data_platform_with_clickhouse_by_Sachidanad_Gaurav_Nutanix.pdf) |
337+
| [Nvidia](https://www.nvidia.com/) | Software & Technology | NVIDIA AI Aerial | — | — | [Documentation](https://docs.nvidia.com/aerial/archive/aerial-dt/1.0/text/overview.html#clickhouse) |
338+
| [Oden](https://oden.io/) | Software & Technology | Manufacturing
332339
| [Oden](https://oden.io/) | Software & Technology | Manufacturing | — | — | [Meetup, April 2023](https://www.youtube.com/watch?v=pAKGJDOO6lo) |
333340
| [Odoscope](https://www.odoscope.com/) | Software & Technology | Customer Engagement Platform | — | — | [Awards Submission, February 2023](https://ecommercegermanyawards.com/vote/164051) |
334341
| [Ok.ru](https://ok.ru) | Social Network | — | 72 servers | 810 TB compressed, 50bn rows/day, 1.5 TB/day | [SmartData conference, October 2021](https://assets.ctfassets.net/oxjq45e8ilak/4JPHkbJenLgZhBGGyyonFP/57472ec6987003ec4078d0941740703b/____________________ClickHouse_______________________.pdf) |
@@ -384,6 +391,7 @@ The following list of companies using ClickHouse and their success stories is as
384391
| [Rambler](https://rambler.ru) | Internet services | Analytics | — | — | [Talk in Russian, April 2018](https://medium.com/@ramblertop/разработка-api-clickhouse-для-рамблер-топ-100-f4c7e56f3141) |
385392
| [Ramp](https://ramp.com/) | Financial Services | Real-Time Analytics, Fraud Detection | — | — | [NYC Meetup, March 2024](https://www.youtube.com/watch?v=7BtUgUb4gCs) |
386393
| [Rapid Delivery Analytics](https://rda.team/) | Retail | Analytics | — | — | ClickHouse Cloud user |
394+
| [Real Estate Analytics](https://rea-global.com/) | Software & Technology | Real-time Analytics | - | - | [Singapore meetup, February 2025](https://clickhouse.com/videos/singapore-meetup-real-estate-analytics-clickhouse-journey) |
387395
| [Releem](https://releem.com/) | Databases | MySQL management| - | - | [Blog 2024](https://releem.com/blog/whats-new-at-releem-june-2023) |
388396
| [Replica](https://replicahq.com) | Urban Planning | Analytics | — | — | [Job advertisement](https://boards.greenhouse.io/replica/jobs/5547732002?gh_jid=5547732002) |
389397
| [Request Metrics](https://requestmetrics.com/) | Software & Technology | Observability | — | — | [Hacker News, May 2023](https://news.ycombinator.com/item?id=35982281) |
@@ -421,7 +429,7 @@ The following list of companies using ClickHouse and their success stories is as
421429
| [ServiceNow](https://www.servicenow.com/) | Managed Services | Qualitative Mobile Analytics | — | — | [Meetup Video, January 2023](https://www.youtube.com/watch?v=b4Pmpx3iRK4&list=PL0Z2YDlm0b3iNDUzpY1S3L_iV4nARda_U&index=6) [Slides, January 2023](https://github.com/ClickHouse/clickhouse-presentations/blob/master/meetup68/Appsee%20Remodeling%20-%20ClickHouse.pdf) |==
422430
| [Sewer AI](https://www.sewerai.com/) | Software & Technology | - | — | — | ClickHouse Cloud user |
423431
| [Shopee](https://www.shopee.com/) | E-Commerce | Distributed Tracing | - | - | [Meetup Video, April 2024](https://youtu.be/_BVy-V2wy9s?feature=shared) [Slides, April 2024](https://raw.githubusercontent.com/ClickHouse/clickhouse-presentations/master/2024-meetup-singapore-1/Shopee%20-%20Distributed%20Tracing%20in%20ClickHouse.pdf) [Blog Post, June 2024](https://clickhouse.com/blog/seeing-the-big-picture-shopees-journey-to-distributed-tracing-with-clickhouse) |
424-
| [SigNoz](https://signoz.io/) | Observability Platform | Main Product | — | — | [Source code](https://github.com/SigNoz/signoz) |
432+
| [SigNoz](https://signoz.io/) | Observability Platform | Main Product | — | — | [Source code](https://github.com/SigNoz/signoz) , [Bangalore Meetup, February 2025](https://clickhouse.com/videos/lessons-from-building-a-scalable-observability-backend)|
425433
| [Sina](http://english.sina.com/index.html) | News | — | — | — | [Slides in Chinese, October 2018](https://github.com/ClickHouse/clickhouse-presentations/blob/master/meetup19/6.%20ClickHouse最佳实践%20高鹏_新浪.pdf) |
426434
| [Sinch](https://www.sinch.com/) | Software & Technology | Customer Communications Cloud | — | — | [HackerNews, May 2023](https://news.ycombinator.com/item?id=36042104) |
427435
| [Sipfront](https://www.sipfront.com/) | Software Development | Analytics | — | — | [Twitter, October 2021](https://twitter.com/andreasgranig/status/1446404332337913895?s=20) |

0 commit comments

Comments
 (0)