Skip to content

Commit b2972a1

Browse files
CopilotBlargian
andcommitted
Convert headers to sentence case across all documentation
Co-authored-by: Blargian <[email protected]>
1 parent 254aa08 commit b2972a1

File tree

453 files changed

+2356
-2356
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

453 files changed

+2356
-2356
lines changed

contribute/CODE_OF_CONDUCT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ClickHouse Community Code of Conduct
1+
# ClickHouse community code of conduct
22
This code of conduct governs ClickHouse Community discussions, channels, and events.
33

44
## Introduction {#introduction}
@@ -7,13 +7,13 @@ This code of conduct governs ClickHouse Community discussions, channels, and eve
77
* Our goal is to maintain a safe and friendly community for everyone, regardless of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other defining characteristic.
88
* This code and related procedures apply to unacceptable behavior occurring in all community venues, including behavior outside the scope of community activities — online and in-person — as well as in all one-on-one communications, and anywhere such behavior has the potential to adversely affect the safety and well-being of community members.
99

10-
## Expected Behavior {#expected-behavior}
10+
## Expected behavior {#expected-behavior}
1111
* Be welcoming.
1212
* Be kind and patient.
1313
* Look out for each other.
1414
* Be careful and aware of your wording and tone.
1515

16-
## Unacceptable Behavior {#unacceptable-behavior}
16+
## Unacceptable behavior {#unacceptable-behavior}
1717
* Conduct or speech which might be considered sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory or offensive in nature.
1818
* Do not use unwelcome, suggestive, derogatory or inappropriate nicknames or terms.
1919
* Do not show disrespect towards others. (Jokes, innuendo, dismissive attitudes.)

contribute/contrib-writing-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Our build process is a little different because part of our docs are in the [Cli
3131
The documentation is built with Docusaurus, which requires Node.js. We recommend version 18. Install [Node.js](https://nodejs.org/en/download/).
3232

3333

34-
### Installing npm and yarn {#installing-npm-and-yarn}
34+
### Installing NPM and yarn {#installing-npm-and-yarn}
3535

3636
We use [yarn classic](https://classic.yarnpkg.com/lang/en/) to build the ClickHouse docs.
3737

@@ -146,12 +146,12 @@ We have seen more and more 404s as the size of the docs grow.
146146
It seems that these are related to the use of `../` in the path to the markdown files. Please write links to other doc
147147
pages as:
148148

149-
#### link to another doc {#link-to-another-doc}
149+
#### Link to another doc {#link-to-another-doc}
150150
```md title="foo"
151151
[async_insert](/operations/settings/settings.md)
152152
```
153153

154-
#### link to an anchor within another doc {#link-to-an-anchor-within-another-doc}
154+
#### Link to an anchor within another doc {#link-to-an-anchor-within-another-doc}
155155

156156
```md
157157
[async_insert](/operations/settings/settings.md/#async-insert)
@@ -252,7 +252,7 @@ Some docs contain information for both Cloud and Self-managed ClickHouse, and so
252252

253253
Note: in the examples below you may notice that the H1 and H2 headers are outside of the tabs, the right-side "What's on this page" nav is built from the H1,2,3 headers in the main body of the markdown file, headings within the tabs are not currently included.
254254

255-
### Differences between Cloud and Self-managed {#differences-between-cloud-and-self-managed}
255+
### Differences between cloud and Self-managed {#differences-between-cloud-and-self-managed}
256256

257257
Backup and restore are very different across Cloud and Self-managed as the target for the backup does not need to be specified, etc. The backup docs are an example where there is no content reused, so everything goes into one tab or the other. This is how the tabs are constructed:
258258

contribute/style-guide.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ doc_type: 'reference' (or 'guide' or 'changelog')
2020
---
2121
```
2222

23-
### Associated markdown rule or CI check
23+
### Associated Markdown rule or ci check
2424

25-
#### front-matter validation
25+
#### Front-matter validation
2626

2727
There is a custom Docusaurus plugin which runs on build that makes the following
2828
checks on front-matter:
@@ -46,7 +46,7 @@ For example:
4646
## My header {#my-header}
4747
```
4848

49-
### Associated markdown rule or CI check
49+
### Associated Markdown rule or ci check
5050
- [`custom-anchor-headings`](/scripts/.markdownlint-cli2.yaml)
5151

5252
## Images
@@ -214,7 +214,7 @@ Processed 335.87 thousand rows,
214214
13.54 MB (12.91 million rows/s., 520.38 MB/s.)
215215
```
216216

217-
### Associated markdown rule or CI check
217+
### Associated Markdown rule or ci check
218218

219219
- [`MD040` enforces that codeblocks have a language specified](/scripts/.markdownlint-cli2.yaml)
220220

@@ -249,7 +249,7 @@ imported by that page. Find the snippet location from the import statement at th
249249
Docusaurus also has a built-in broken anchor checker. Unfortunately it sometimes
250250
can give false positives.
251251

252-
### linking to spans
252+
### Linking to spans
253253

254254
Sometimes you want to link to something other than a header. It is logical to
255255
use a span for this purpose. For instance if you want to link to an image.
@@ -335,7 +335,7 @@ which may need versioned documentation, we use the following custom
335335

336336
The `ClientVersionDropdown` component supports two APIs:
337337

338-
#### API 1: Inline Content (Recommended)
338+
#### API 1: inline content (recommended)
339339

340340
This approach keeps all content in the main file, which allows Docusaurus to properly generate the table of contents (TOC) for all versions.
341341

@@ -375,7 +375,7 @@ Your v0.7.x content here...
375375
- The TOC will show only headers from the currently selected version
376376
- The component will display the first version as 'selected' by default
377377

378-
#### API 2: External Snippets (Legacy)
378+
#### API 2: external snippets (legacy)
379379

380380
This approach uses separate snippet files for each version. Note that this method has limitations with TOC generation.
381381

@@ -458,7 +458,7 @@ in your component configuration. For example:
458458
- URL: `docs/api?v=v08`
459459
- Matches: `version: 'v0.8+'` in your dropdown configuration
460460

461-
#### Conventions That Work
461+
#### Conventions that work
462462

463463
- **Simple Version Strings**: Parameters like `?v=v08`, `?v=v07` work by
464464
- matching against stripped versions of your configured version names.
@@ -471,7 +471,7 @@ in your component configuration. For example:
471471
- **Preserving Other Parameters**: Other URL parameters are preserved when
472472
switching versions.
473473

474-
#### What Won't Work
474+
#### What won't work
475475

476476
- **Partial Matches**: `?v=8` won't match `v0.8` with the default implementation.
477477

@@ -481,7 +481,7 @@ require more sophisticated matching logic. (Reach out to the docs team if requir
481481
- **Non-Standard Formats**: Version formats not accounted for in the matching
482482
logic might fail.
483483

484-
#### Best Practices
484+
#### Best practices
485485

486486
1. Keep version strings in consistent formats for predictable results.
487487

docs/_snippets/_GCS_authentication_and_bucket.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ import Image from '@theme/IdealImage';
1111
<details>
1212
<summary>Create GCS buckets and an HMAC key</summary>
1313

14-
### ch_bucket_us_east1 {#ch_bucket_us_east1}
14+
### Ch_bucket_us_east1 {#ch_bucket_us_east1}
1515

1616
<Image size="md" img={GCS_bucket_1} alt="Creating a GCS bucket in US East 1" border />
1717

18-
### ch_bucket_us_east4 {#ch_bucket_us_east4}
18+
### Ch_bucket_us_east4 {#ch_bucket_us_east4}
1919

2020
<Image size="md" img={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" border />
2121

2222
### Generate an access key {#generate-an-access-key}
2323

24-
### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret}
24+
### Create a service account hmac key and secret {#create-a-service-account-hmac-key-and-secret}
2525

2626
Open **Cloud Storage > Settings > Interoperability** and either choose an existing **Access key**, or **CREATE A KEY FOR A SERVICE ACCOUNT**. This guide covers the path for creating a new key for a new service account.
2727

docs/_snippets/_S3_authentication_and_bucket.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import s3_h from '@site/static/images/_snippets/s3/s3-h.png';
2222

2323
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.
2424

25-
### Create an AWS IAM user {#create-an-aws-iam-user}
25+
### Create an AWS iam user {#create-an-aws-iam-user}
2626
In this procedure, we'll be creating a service account user, not a login user.
2727
1. Log into the AWS IAM Management Console.
2828

docs/_snippets/_direct_observability_integration_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import NativeAdvancedDashboard from '@site/static/images/cloud/manage/monitoring
77
The ClickHouse data source plugin for Grafana enables visualization and exploration of data directly from ClickHouse using system tables. This approach works well for monitoring performance and creating custom dashboards for detailed system analysis.
88
For plugin installation and configuration details, see the ClickHouse [data source plugin](/integrations/grafana). For a complete monitoring setup using the Prometheus-Grafana mix-in with pre-built dashboards and alerting rules, see [Monitor ClickHouse with the new Prometheus-Grafana mix-in](https://clickhouse.com/blog/monitor-with-new-prometheus-grafana-mix-in).
99

10-
### Direct Datadog Integration {#direct-datadog}
10+
### Direct Datadog integration {#direct-datadog}
1111

1212
Datadog offers a Clickhouse Monitoring plugin for its agent which queries system tables directly. This integration provides comprehensive database monitoring with cluster awareness through clusterAllReplicas functionality.
1313
:::note

docs/_snippets/_observability_integration_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import NativeAdvancedDashboard from '@site/static/images/cloud/manage/monitoring
77
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.
88
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.
99

10-
### Grafana Cloud monitoring {#grafana}
10+
### Grafana cloud monitoring {#grafana}
1111

1212
Grafana provides ClickHouse monitoring through both direct plugin integration and Prometheus-based approaches. The Prometheus endpoint integration maintains operational separation between monitoring and production workloads while enabling visualization within existing Grafana Cloud infrastructure. See [Grafana's ClickHouse documentation](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-clickhouse/) for configuration guidance.
1313

docs/_snippets/_users-and-roles-common.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Roles are used to define groups of users for certain privileges instead of manag
183183

184184
<VerticalStepper headerLevel="h5">
185185

186-
##### Log into the clickhouse client using the `clickhouse_admin` user {#login-admin-user}
186+
##### Log into the ClickHouse client using the `clickhouse_admin` user {#login-admin-user}
187187

188188
```bash
189189
clickhouse-client --user clickhouse_admin --password password

docs/about-us/cloud.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ keywords: ['ClickHouse Cloud', 'cloud database', 'managed ClickHouse', 'serverle
88
doc_type: 'reference'
99
---
1010

11-
# ClickHouse Cloud
11+
# ClickHouse cloud
1212

1313
ClickHouse Cloud is the cloud offering created by the original creators of the popular open-source OLAP database ClickHouse.
1414
You can experience ClickHouse Cloud by [starting a free trial](https://console.clickhouse.cloud/signUp).
1515

16-
## ClickHouse Cloud benefits {#clickhouse-cloud-benefits}
16+
## ClickHouse cloud benefits {#clickhouse-cloud-benefits}
1717

1818
Some of the benefits of using ClickHouse Cloud are described below:
1919

@@ -25,7 +25,7 @@ Some of the benefits of using ClickHouse Cloud are described below:
2525
- **Broad ecosystem**: Bring your favorite data connectors, visualization tools, SQL and language clients with you.
2626

2727
<!--
28-
## OSS vs ClickHouse Cloud comparison {#oss-vs-clickhouse-cloud}
28+
## OSS vs ClickHouse cloud comparison {#oss-vs-clickhouse-cloud}
2929
3030
| Feature | Benefits | OSS ClickHouse | ClickHouse Cloud |
3131
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------------|
@@ -45,7 +45,7 @@ Some of the benefits of using ClickHouse Cloud are described below:
4545
| **Managed services** | With a cloud-managed service, teams can focus on business outcomes and accelerate time-to-market without having to worry about the operational overhead of sizing, setup, and maintenance of ClickHouse. | ❌ | ✅ |
4646
-->
4747

48-
## What version of ClickHouse does ClickHouse Cloud use? {#what-version-of-clickhouse-does-clickhouse-cloud-use}
48+
## What version of ClickHouse does ClickHouse cloud use? {#what-version-of-clickhouse-does-clickhouse-cloud-use}
4949

5050
Clickhouse Cloud continuously upgrades your service to a newer version. After publishing a core database version in the open source, we do additional validation in our cloud staging environment, which typically takes 6-8 weeks before rolling out to production. The rollout is phased out by cloud service provider, service type, and region.
5151

docs/about-us/distinctive-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ ClickHouse uses asynchronous multi-master replication. After being written to an
8888

8989
For more information, see the section [Data replication](../engines/table-engines/mergetree-family/replication.md).
9090

91-
## Role-Based Access Control {#role-based-access-control}
91+
## Role-based access control {#role-based-access-control}
9292

9393
ClickHouse implements user account management using SQL queries and allows for [role-based access control configuration](/guides/sre/user-management/index.md) similar to what can be found in the ANSI SQL standard and popular relational database management systems.
9494

0 commit comments

Comments
 (0)