Skip to content

Commit 84e6f95

Browse files
authored
Apply suggestions from code review
1 parent f901d6d commit 84e6f95

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

docs/about-us/cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: 'ClickHouse Cloud'
1111
ClickHouse Cloud is the cloud offering created by the original creators of the popular open-source OLAP database ClickHouse.
1212
You can experience ClickHouse Cloud by [starting a free trial](https://console.clickhouse.cloud/signUp).
1313

14-
### ClickHouse Cloud benefits {#clickhouse-cloud-benefits}
14+
## ClickHouse Cloud benefits {#clickhouse-cloud-benefits}
1515

1616
Some of the benefits of using ClickHouse Cloud are described below:
1717

docs/best-practices/sizing-and-hardware-recommendations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: 'Sizing and hardware recommendations'
66
description: 'This guide discusses our general recommendations regarding hardware, compute, memory, and disk configurations for open-source users.'
77
---
88

9-
# Sizing and hardware recommendations'
9+
# Sizing and hardware recommendations
1010

1111
This guide discusses our general recommendations regarding hardware, compute, memory, and disk configurations for open-source users. If you would like to simplify your setup, we recommend using [ClickHouse Cloud](https://clickhouse.com/cloud) as it automatically scales and adapts to your workloads while minimizing costs pertaining to infrastructure management.
1212

docs/cloud/manage/account-close.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ title: 'Account Close & Deletion'
55
description: 'We know there are circumstances that sometimes necessitate account closure. This guide will help you through the process.'
66
---
77

8-
## Account close & deletion {#account-close--deletion}
8+
## Account closure and deletion {#account-close--deletion}
99
Our goal is to help you be successful in your project. If you have questions that are not answered on this site or need help evaluating a
1010
unique use case, please contact us at [[email protected]](mailto:[email protected]).
1111

1212
We know there are circumstances that sometimes necessitate account closure. This guide will help you through the process.
1313

14-
## Close vs delete {#close-vs-delete}
14+
## Close versus delete your account {#close-vs-delete}
1515
Customers may log back into closed accounts to view usage, billing and account-level activity logs. This enables you to easily access
1616
details that are useful for a variety of purposes, from documenting use cases to downloading invoices at the end of the year for tax purposes.
1717
You will also continue receiving product updates so that you know if a feature you may have been waiting for is now available. Additionally,
@@ -31,7 +31,7 @@ Before requesting account closure, please take the following steps to prepare th
3131
3. Remove all users except the admin that will request closure. This will help you ensure no new services are created while the process completes.
3232
4. Review the 'Usage' and 'Billing' tabs in the control panel to verify all charges have been paid. We are not able to close accounts with unpaid balances.
3333

34-
## Request account closure {#request-account-closure}
34+
## Request an account closure {#request-account-closure}
3535

3636
We are required to authenticate requests for both closure and deletion. To ensure your request can be processed quickly, please follow the steps outlined
3737
below.
@@ -51,7 +51,7 @@ Description: We would appreciate it if you would share a brief note about why yo
5151
6. We will close your account and send a confirmation email to let you know when it is complete.
5252

5353

54-
## Request personal data deletion {#request-personal-data-deletion}
54+
## Request deletion of your personal data {#request-personal-data-deletion}
5555
Please note, only account administrators may request personal data deletion from ClickHouse. If you are not an account administrator, please contact
5656
your ClickHouse account administrator to request to be removed from the account.
5757

docs/cloud/security/aws-privatelink.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ ClickHouse Cloud currently supports [cross-region PrivateLink](https://aws.amazo
3939
Find Terraform examples [here](https://github.com/ClickHouse/terraform-provider-clickhouse/tree/main/examples/).
4040

4141

42-
## Attention to the following {#attention}
42+
## Points of attention {#attention}
4343
ClickHouse attempts to group your services to reuse the same published [service endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html#endpoint-service-overview) within the AWS region. However, this grouping is not guaranteed, especially if you spread your services across multiple ClickHouse organizations.
4444
If you already have PrivateLink configured for other services in your ClickHouse organization, you can often skip most of the steps because of that grouping and proceed directly to the final step: Add ClickHouse "Endpoint ID" to ClickHouse service allow list.
4545

docs/deployment-guides/replicated.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Install ClickHouse Keeper on the three servers `clickhouse-keeper-01`, `clickhou
4646

4747
<ConfigFileNote />
4848

49-
## Clickhouse-01 configuration {#clickhouse-01-configuration}
49+
## Configure `clickhouse-01` {#clickhouse-01-configuration}
5050

5151
For clickhouse-01 there are five configuration files. You may choose to combine these files into a single file, but for clarity in the documentation it may be simpler to look at them separately. As you read through the configuration files you will see that most of the configuration is the same between clickhouse-01 and clickhouse-02; the differences will be highlighted.
5252

@@ -143,7 +143,7 @@ This configuration file `use-keeper.xml` is configuring ClickHouse Server to use
143143
</clickhouse>
144144
```
145145

146-
## Clickhouse-02 configuration {#clickhouse-02-configuration}
146+
## Configure `clickhouse-02` {#clickhouse-02-configuration}
147147

148148
As the configuration is very similar on clickhouse-01 and clickhouse-02 only the differences will be pointed out here.
149149

@@ -232,7 +232,7 @@ This file is the same on both clickhouse-01 and clickhouse-02.
232232
</clickhouse>
233233
```
234234

235-
## Clickhouse-keeper-01 configuration {#clickhouse-keeper-01-configuration}
235+
## Configure `clickhouse-keeper-01` {#clickhouse-keeper-01-configuration}
236236

237237
<KeeperConfigFileNote />
238238

@@ -286,7 +286,7 @@ If for any reason a Keeper node is replaced or rebuilt, do not reuse an existing
286286
</clickhouse>
287287
```
288288

289-
## Clickhouse-keeper-02 configuration {#clickhouse-keeper-02-configuration}
289+
## Configure `clickhouse-keeper-02` {#clickhouse-keeper-02-configuration}
290290

291291
There is only one line difference between `clickhouse-keeper-01` and `clickhouse-keeper-02`. `server_id` is set to `2` on this node.
292292

@@ -334,7 +334,7 @@ There is only one line difference between `clickhouse-keeper-01` and `clickhouse
334334
</clickhouse>
335335
```
336336

337-
## Clickhouse-keeper-03 configuration {#clickhouse-keeper-03-configuration}
337+
## Configure `clickhouse-keeper-03` {#clickhouse-keeper-03-configuration}
338338

339339
There is only one line difference between `clickhouse-keeper-01` and `clickhouse-keeper-03`. `server_id` is set to `3` on this node.
340340

docs/getting-started/example-datasets/nypd_complaint_data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ of `ORDER BY` or `PRIMARY KEY` must be specified. Here are some guidelines on d
365365
columns to includes in `ORDER BY`, and more information is in the *Next Steps* section at the end
366366
of this document.
367367

368-
### Order by and primary key clauses {#order-by-and-primary-key-clauses}
368+
### `ORDER BY` and `PRIMARY KEY` clauses {#order-by-and-primary-key-clauses}
369369

370370
- The `ORDER BY` tuple should include fields that are used in query filters
371371
- To maximize compression on disk the `ORDER BY` tuple should be ordered by ascending cardinality

docs/guides/best-practices/skipping-indexes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ queries. In circumstances where querying a table is too expensive unless a skip
174174
names will return an exception for any query that does not use the listed index. This would prevent poorly written queries from
175175
consuming server resources.
176176

177-
## Skip best practices {#skip-best-practices}
177+
## Skip index best practices {#skip-best-practices}
178178

179179
Skip indexes are not intuitive, especially for users accustomed to secondary row-based indexes from the RDMS realm or inverted indexes from document stores. To get any benefit, applying a ClickHouse data skipping index must avoid enough granule reads to offset the cost of calculating the index. Critically, if a value occurs even once in an indexed block, it means the entire block must be read into memory and evaluated, and the index cost has been needlessly incurred.
180180

0 commit comments

Comments
 (0)