-
Notifications
You must be signed in to change notification settings - Fork 412
Ensure headers are in sentence case except for product names #4921
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -20,9 +20,9 @@ doc_type: 'reference' (or 'guide' or 'changelog') | |||||
| --- | ||||||
| ``` | ||||||
|
|
||||||
| ### Associated markdown rule or CI check | ||||||
| ### Associated Markdown rule or ci check | ||||||
|
||||||
|
|
||||||
| #### front-matter validation | ||||||
| #### Front-matter validation | ||||||
|
|
||||||
| There is a custom Docusaurus plugin which runs on build that makes the following | ||||||
| checks on front-matter: | ||||||
|
|
@@ -46,7 +46,7 @@ For example: | |||||
| ## My header {#my-header} | ||||||
| ``` | ||||||
|
|
||||||
| ### Associated markdown rule or CI check | ||||||
| ### Associated Markdown rule or ci check | ||||||
| - [`custom-anchor-headings`](/scripts/.markdownlint-cli2.yaml) | ||||||
|
|
||||||
| ## Images | ||||||
|
|
@@ -214,7 +214,7 @@ Processed 335.87 thousand rows, | |||||
| 13.54 MB (12.91 million rows/s., 520.38 MB/s.) | ||||||
| ``` | ||||||
|
|
||||||
| ### Associated markdown rule or CI check | ||||||
| ### Associated Markdown rule or ci check | ||||||
|
||||||
| ### Associated Markdown rule or ci check | |
| ### Associated markdown rule or CI check |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139.
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,17 +11,17 @@ import Image from '@theme/IdealImage'; | |||||
| <details> | ||||||
| <summary>Create GCS buckets and an HMAC key</summary> | ||||||
|
|
||||||
| ### ch_bucket_us_east1 {#ch_bucket_us_east1} | ||||||
| ### Ch_bucket_us_east1 {#ch_bucket_us_east1} | ||||||
|
||||||
| ### Ch_bucket_us_east1 {#ch_bucket_us_east1} | |
| ### ch_bucket_us_east1 {#ch_bucket_us_east1} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### Ch_bucket_us_east4 {#ch_bucket_us_east4} | |
| ### ch_bucket_us_east4 {#ch_bucket_us_east4} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### Create a service account hmac key and secret {#create-a-service-account-hmac-key-and-secret} | |
| ### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139. Changed to "Create a service account HMAC key and secret".
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -22,7 +22,7 @@ import s3_h from '@site/static/images/_snippets/s3/s3-h.png'; | |||||
|
|
||||||
| This article demonstrates the basics of how to configure an AWS IAM user, create an S3 bucket and configure ClickHouse to use the bucket as an S3 disk. You should work with your security team to determine the permissions to be used, and consider these as a starting point. | ||||||
|
|
||||||
| ### Create an AWS IAM user {#create-an-aws-iam-user} | ||||||
| ### Create an AWS iam user {#create-an-aws-iam-user} | ||||||
|
||||||
| ### Create an AWS iam user {#create-an-aws-iam-user} | |
| ### Create an AWS IAM user {#create-an-aws-iam-user} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139. Changed "AWS iam user" to "AWS IAM user".
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -7,7 +7,7 @@ import NativeAdvancedDashboard from '@site/static/images/cloud/manage/monitoring | |||||
| External integration allows organizations to maintain established monitoring workflows, leverage existing team expertise with familiar tools, and integrate ClickHouse monitoring with broader infrastructure observability without disrupting current processes or requiring significant retraining investments. | ||||||
| Teams can apply existing alerting rules and escalation procedures to ClickHouse metrics, while correlating database performance with application and infrastructure health within a unified observability platform. This approach maximizes ROI on current monitoring setups and enables faster troubleshooting through consolidated dashboards and familiar tooling interfaces. | ||||||
|
|
||||||
| ### Grafana Cloud monitoring {#grafana} | ||||||
| ### Grafana cloud monitoring {#grafana} | ||||||
|
||||||
| ### Grafana cloud monitoring {#grafana} | |
| ### Grafana Cloud monitoring {#grafana} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139. Changed "Grafana cloud monitoring" to "Grafana Cloud monitoring".
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -91,7 +91,7 @@ Compressing insert data reduces the size of the payload sent over the network, m | |||||
|
|
||||||
| For inserts, compression is especially effective when used with the Native format, which already matches ClickHouse's internal columnar storage model. In this setup, the server can efficiently decompress and directly store the data with minimal transformation. | ||||||
|
|
||||||
| #### Use LZ4 for speed, ZSTD for compression ratio {#use-lz4-for-speed-zstd-for-compression-ratio} | ||||||
| #### Use lz4 for speed, zstd for compression ratio {#use-lz4-for-speed-zstd-for-compression-ratio} | ||||||
|
||||||
| #### Use lz4 for speed, zstd for compression ratio {#use-lz4-for-speed-zstd-for-compression-ratio} | |
| #### Use LZ4 for speed, ZSTD for compression ratio {#use-lz4-for-speed-zstd-for-compression-ratio} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139. Changed to "Use LZ4 for speed, ZSTD for compression ratio".
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -37,7 +37,7 @@ | |||||
|
|
||||||
| ## CPU {#cpu} | ||||||
|
|
||||||
| ### Which CPU should I use? {#which-cpu-should-i-use} | ||||||
| ### Which CPU should i use? {#which-cpu-should-i-use} | ||||||
|
||||||
|
|
||||||
| The type of CPU you should use depends on your usage pattern. In general, however, applications with many frequent concurrent queries, that process more data, or that use compute-intensive UDFs will require more CPU cores. | ||||||
|
|
||||||
|
|
@@ -59,7 +59,7 @@ | |||||
|
|
||||||
| There is no standard CPU utilization target for ClickHouse. Utilize a tool such as [iostat](https://linux.die.net/man/1/iostat) to measure average CPU usage, and accordingly adjust the size of your servers to manage unexpected traffic spikes. However, for analytical or data warehousing use cases with ad-hoc queries, you should target 10-20% CPU utilization. | ||||||
|
|
||||||
| ### How many CPU cores should I use? {#how-many-cpu-cores-should-i-use} | ||||||
| ### How many CPU cores should i use? {#how-many-cpu-cores-should-i-use} | ||||||
|
|
||||||
| The number of CPUs you should use depends on your workload. However, we generally recommend the following memory-to-CPU-core ratios based on your CPU type: | ||||||
|
|
||||||
|
|
@@ -102,7 +102,7 @@ | |||||
|
|
||||||
| To provide guidance (not recommendations), the following are example configurations of ClickHouse users in production: | ||||||
|
|
||||||
| ### Fortune 500 B2B SaaS {#fortune-500-b2b-saas} | ||||||
| ### Fortune 500 b2b saas {#fortune-500-b2b-saas} | ||||||
|
Check warning on line 105 in docs/best-practices/sizing-and-hardware-recommendations.md
|
||||||
|
||||||
| ### Fortune 500 b2b saas {#fortune-500-b2b-saas} | |
| ### Fortune 500 B2B SaaS {#fortune-500-b2b-saas} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139. Changed to "Fortune 500 B2B SaaS".
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -59,7 +59,7 @@ In summary, use refreshable materialized views when: | |||||
|
|
||||||
| For examples of refreshable materialized views see [here](/materialized-view/refreshable-materialized-view). | ||||||
|
|
||||||
| ### APPEND vs REPLACE mode {#append-vs-replace-mode} | ||||||
| ### Append vs replace mode {#append-vs-replace-mode} | ||||||
|
||||||
| ### Append vs replace mode {#append-vs-replace-mode} | |
| ### APPEND vs REPLACE mode {#append-vs-replace-mode} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139. Changed to "APPEND vs REPLACE mode".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot here Cloud is a product (ClickHouse Cloud) and so it should be capitalised. You can make "Self-managed" lower-case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit faf7139. Changed "cloud and Self-managed" to "Cloud and self-managed".