Skip to content

Commit 971abf9

Browse files
gingerwizardgingerwizard
committed
merge main
2 parents 21b6284 + d86e33e commit 971abf9

File tree

134 files changed

+1370
-502
lines changed

Some content is hidden

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

134 files changed

+1370
-502
lines changed

‎.github/workflows/check-build.yml

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,30 @@ jobs:
3131
continue-on-error: true
3232
id: spellcheck
3333

34-
# Step 4: Fail the build if the script returns exit code 1
34+
# Step 4: Setup Python and dependencies for KB checker
35+
- name: Set up Python
36+
uses: actions/setup-python@v3
37+
with:
38+
python-version: '3.x'
39+
40+
# Step 5: Install Python dependencies
41+
- name: Install dependencies
42+
run: |
43+
python -m pip install --upgrade pip
44+
pip install -r 'scripts/knowledgebase-checker/requirements.txt'
45+
46+
# Step 5: Run knowledgebase article checker
47+
- name: Check KB
48+
run: |
49+
./scripts/knowledgebase-checker/knowledgebase_article_checker.py --kb-dir="knowledgebase"
50+
continue-on-error: true
51+
id: kbcheck
52+
53+
# Step 6: Fail the build if any script returns exit code 1
3554
- name: Check exit code
3655
run: |
37-
if [ ${{ steps.spellcheck.outcome }} == 'failure' ]; then
38-
echo "Spellcheck failed. See the logs for details."
56+
if [[ "${{ steps.spellcheck.outcome }}" == "failure" ]] || [[ "${{ steps.kbcheck.outcome }}" == "failure" ]]; then
57+
echo "Style check failed. See the logs for details."
3958
exit 1
4059
fi
60+

‎docs/en/cloud/bestpractices/index.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ hide_title: true
99

1010
This section provides six best practices you will want to follow to get the most out of ClickHouse Cloud.
1111

12-
| Best Practice |
13-
|------------------------------------------------------------------------------------------------------------|
14-
| [Use Bulk Inserts](/docs/en/cloud/bestpractices/bulk-inserts) |
15-
| [Asynchronous Inserts](/docs/en/cloud/bestpractices/asynchronous-inserts) |
16-
| [Avoid Mutations](/docs/en/cloud/bestpractices/avoid-mutations) |
17-
| [Avoid Nullable Columns](/docs/en/cloud/bestpractices/avoid-nullable-columns) |
18-
| [Avoid Optimize Final](/docs/en/cloud/bestpractices/avoid-optimize-final) |
19-
| [Choose a Low Cardinality Partitioning Key](/docs/en/cloud/bestpractices/low-cardinality-partitioning-key) |
12+
| Page | Description |
13+
|----------------------------------------------------------|----------------------------------------------------------------------------|
14+
| [Use Bulk Inserts](/docs/en/cloud/bestpractices/bulk-inserts) | Learn why you should ingest data in bulk in ClickHouse |
15+
| [Asynchronous Inserts](/docs/en/cloud/bestpractices/asynchronous-inserts) | Learn how to asynchronously insert data if bulk inserts are not an option. |
16+
| [Avoid Mutations](/docs/en/cloud/bestpractices/avoid-mutations) | Learn why you should avoid mutations which trigger rewrites. |
17+
| [Avoid Nullable Columns](/docs/en/cloud/bestpractices/avoid-nullable-columns) | Learn why you should ideally avoid Nullable columns |
18+
| [Avoid Optimize Final](/docs/en/cloud/bestpractices/avoid-optimize-final) | Learn why you should avoid `OPTIMIZE TABLE ... FINAL` |
19+
| [Choose a Low Cardinality Partitioning Key](/docs/en/cloud/bestpractices/low-cardinality-partitioning-key) | Learn how to choose a low cardinality partitioning key. |
20+
| [Usage Limits](/docs/en/cloud/bestpractices/usage-limits)| Explore the limits of ClickHouse. |

‎docs/en/cloud/get-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
slug: en/cloud/get-started
2+
slug: /en/cloud/get-started
33
title: Get Started
44
description: Get Started Table Of Contents
55
keywords: [Cloud Quick Start, SQL Console, Query Insights, Query API Endpoints, Dashboards, Cloud Support]

‎docs/en/cloud/manage/api/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
title: Cloud API
3-
slug: en/cloud/manage/api
3+
slug: /en/cloud/manage/cloud-api
44
---
55

6-
| Page | Description |
7-
|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
8-
| [Overview](/docs/en/cloud/manage/api/api-overview) | Provides an overview of rate limits, Terraform Provider, Swagger (OpenAPI) Endpoint and UI and available support. |
9-
| [Managing API Keys](/docs/en/cloud/manage/openapi)| Learn more about Cloud's API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services. |
10-
| [API Reference](/docs/en/cloud/manage/api) | API reference documentation. |
6+
This section contains reference documentation for Cloud API and contains the following pages:
7+
8+
| Page | Description |
9+
|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
10+
| [Overview](/docs/en/cloud/manage/api/api-overview)| Provides an overview of rate limits, Terraform Provider, Swagger (OpenAPI) Endpoint and UI and available support. |
11+
| [Managing API Keys](/docs/en/cloud/manage/openapi) | Learn more about Cloud's API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services. |
12+
| [API Reference](/docs/en/cloud/manage/api) | API reference documentation. |

‎docs/en/cloud/manage/billing/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ description: Table of contents page for billing.
55
keywords: [billing, payment thresholds, trouble shooting, marketplace]
66
---
77

8-
| Page |
9-
|----------------------------------------------------------------------------------|
10-
| [Overview](/docs/en/cloud/marketplace/marketplace-billing) |
11-
| [Payment Thresholds](/docs/en/cloud/billing/payment-thresholds) |
12-
| [Troubleshooting Billing Issues](/docs/en/manage/troubleshooting-billing-issues) |
13-
| [Marketplace](/docs/en/cloud/manage/) |
8+
This section of the documentation covers topics related to billing, and contains the following pages:
9+
10+
| Page | Description |
11+
|---------------------------------------|-----------------------------------------------------------------------|
12+
| [Overview](/docs/en/cloud/marketplace/marketplace-billing) | Overview and FAQ page for marketplace billing. |
13+
| [Payment Thresholds](/docs/en/cloud/billing/payment-thresholds) | Learn more about how payment thresholds work and how to adjust them. |
14+
| [Troubleshooting Billing Issues](/docs/en/manage/troubleshooting-billing-issues) | Troubleshoot common billing issues. |
15+
| [Marketplace](/docs/en/cloud/manage/) | Landing page for further marketplace related topics. |

‎docs/en/cloud/manage/billing/marketplace/index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ description: Market Place Table of Contents page
55
keywords: [Marketplace Billing, AWS, GCP]
66
---
77

8-
| Page |
9-
|---------------------------------------------------------------------------------------------------------------------|
10-
| [Marketplace Billing](/docs/en/cloud/marketplace/marketplace-billing) |
11-
| [AWS Marketplace PAYG](/docs/en/cloud/billing/marketplace/aws-marketplace-payg) |
12-
| [AWS Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/aws-marketplace-committed-contract) |
13-
| [GCP Marketplace PAYG](/docs/en/cloud/billing/marketplace/gcp-marketplace-payg) |
14-
| [GCP Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/gcp-marketplace-committed-contract) |
15-
| [Azure Marketplace PAYG](/docs/en/cloud/billing/marketplace/azure-marketplace-payg) |
16-
| [Azure Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/azure-marketplace-committed-contract) |
8+
This section details billing related topics for Marketplace.
9+
10+
| Page | Description |
11+
|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
12+
| [Marketplace Billing](/docs/en/cloud/marketplace/marketplace-billing) | FAQ on Marketplace billing. |
13+
| [AWS Marketplace PAYG](/docs/en/cloud/billing/marketplace/aws-marketplace-payg) | Get started with ClickHouse Cloud on the AWS Marketplace via a PAYG (Pay-as-you-go) Public Offer. |
14+
| [AWS Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/aws-marketplace-committed-contract) | Get started with ClickHouse Cloud on the AWS Marketplace via a committed contract. A committed contract, also known as a a Private Offer, allows customers to commit to spending a certain amount on ClickHouse Cloud over a period of time. |
15+
| [GCP Marketplace PAYG](/docs/en/cloud/billing/marketplace/gcp-marketplace-payg) | Get started with ClickHouse Cloud on the GCP Marketplace via a PAYG (Pay-as-you-go) Public Offer. |
16+
| [GCP Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/gcp-marketplace-committed-contract) | Get started with ClickHouse Cloud on the GCP Marketplace via a committed contract. A committed contract, also known as a a Private Offer, allows customers to commit to spending a certain amount on ClickHouse Cloud over a period of time. |
17+
| [Azure Marketplace PAYG](/docs/en/cloud/billing/marketplace/azure-marketplace-payg) | Get started with ClickHouse Cloud on the Azure Marketplace via a PAYG (Pay-as-you-go) Public Offer. |
18+
| [Azure Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/azure-marketplace-committed-contract) | Get started with ClickHouse Cloud on the Azure Marketplace via a committed contract. A committed contract, also known as a a Private Offer, allows customers to commit to spending a certain amount on ClickHouse Cloud over a period of time. |

‎docs/en/guides/best-practices/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ description: Overview page of Performance and Optimizations
66

77
# Performance and Optimizations
88

9-
This section covers the following topics:
9+
This section contains tips and best practices for improving performance with ClickHouse.
10+
We recommend users read [Core Concepts](/docs/en/parts) as a precursor to this section,
11+
which covers the main concepts required to improve performance,
12+
especially [Primary Indices](/docs/en/optimize/sparse-primary-indexes).
1013

1114
| Topic | Description |
1215
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

‎docs/en/integrations/language-clients/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
slug: /en/integrations/language-clients
3+
title: Language Clients
4+
description: Table of contents page for Language Clients.
5+
keywords: [Language Clients, C++, Go, JavaScript, Java, Python, Rust]
6+
---
7+
8+
In this section of the documentation, you can learn more about the many language client integrations
9+
that ClickHouse offers.
10+
11+
| Page | Description |
12+
|-------------------------------------------------------------------------|----------------------------------------------------------------------------------|
13+
| [C++](/docs/en/interfaces/cpp) | C++ Client Library and userver Asynchronous Framework |
14+
| [Go](/docs/en/integrations/go) | Learn how to connect your Go projects to ClickHouse. |
15+
| [JavaScript](/docs/en/integrations/javascript) | Learn how to connect your JS projects to ClickHouse with the official JS client. |
16+
| [Java](/docs/en/integrations/java) | Learn more about several integrations for Java and ClickHouse. |
17+
| [Python](/docs/en/integrations/python) | Learn how to connect your Python projects to ClickHouse. |
18+
| [Rust](/docs/en/integrations/rust) | Learn how to connect your Rust projects to ClickHouse. |
19+
| [Third-party clients](/docs/en/interfaces/third-party/client-libraries) | Learn more about client libraries from third party developers. |

‎docs/en/optimize/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docusaurus.config.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,6 @@ const config = {
474474
to: '/en/integrations',
475475
},
476476
{ from: '/en/integrations/intro', to: '/en/integrations' },
477-
{ from: '/en/integrations/language-clients', to: '/en/integrations' },
478477
{
479478
from: '/en/integrations/migration/clickhouse-local',
480479
to: '/en/cloud/migration/clickhouse-local',
@@ -2393,14 +2392,18 @@ const config = {
23932392
from: '/en/deletes',
23942393
to: '/en/deletes/overview'
23952394
},
2395+
{
2396+
from: '/en/optimize',
2397+
to: '/en/operations/overview'
2398+
}
23962399
],
23972400
},
23982401
],
23992402
chHeader
24002403
],
24012404
customFields: {
2405+
blogSidebarLink: '/docs/knowledgebase',
24022406
galaxyApiEndpoint: process.env.NEXT_PUBLIC_GALAXY_API_ENDPOINT || 'http://localhost:3000',
2403-
24042407
secondaryNavItems: [
24052408
{
24062409
type: 'docSidebar',

0 commit comments

Comments
 (0)