Skip to content

Commit 1914e1c

Browse files
BlargianBlargian
authored
Merge pull request #3090 from Blargian/followup_breadcrumbs
Follow up PR for breadcrumbs
2 parents a87cce8 + accd5a8 commit 1914e1c

File tree

11 files changed

+106
-82
lines changed

11 files changed

+106
-82
lines changed

‎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: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,6 @@ const config = {
470470
to: '/en/integrations',
471471
},
472472
{ from: '/en/integrations/intro', to: '/en/integrations' },
473-
{ from: '/en/integrations/language-clients', to: '/en/integrations' },
474473
{
475474
from: '/en/integrations/migration/clickhouse-local',
476475
to: '/en/cloud/migration/clickhouse-local',
@@ -2389,6 +2388,10 @@ const config = {
23892388
from: '/en/deletes',
23902389
to: '/en/deletes/overview'
23912390
},
2391+
{
2392+
from: '/en/optimize',
2393+
to: '/en/operations/overview'
2394+
}
23922395
],
23932396
},
23942397
],

‎sidebars.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,7 @@ const sidebars = {
564564
label: "Language Clients",
565565
collapsed: false,
566566
collapsible: false,
567+
link: {type: "doc", id: "en/integrations/language-clients/index"},
567568
items: [
568569
"en/interfaces/cpp",
569570
"en/integrations/language-clients/go/index",
@@ -1024,7 +1025,6 @@ const sidebars = {
10241025
collapsible: false,
10251026
link: {type: "doc", id: "en/guides/best-practices/index"},
10261027
items: [
1027-
"en/optimize/index",
10281028
"en/operations/analyzer",
10291029
"en/guides/best-practices/asyncinserts",
10301030
"en/guides/best-practices/avoidmutations",
@@ -1526,31 +1526,31 @@ const sidebars = {
15261526
type: 'link',
15271527
label: 'Get Started',
15281528
//description: 'Start quickly with ClickHouse Cloud',
1529-
href: '/docs/en/cloud/overview'
1529+
href: '/docs/en/cloud/get-started/'
15301530
},
15311531
{
15321532
type: 'link',
15331533
label: 'Best Practices',
15341534
//description: 'How to get the most out of ClickHouse Cloud',
1535-
href: '/docs/en/cloud/bestpractices/bulk-inserts'
1535+
href: '/docs/en/cloud/bestpractices'
15361536
},
15371537
{
15381538
type: 'link',
15391539
label: 'Managing Cloud',
15401540
//description: 'Manage your ClickHouse Cloud services',
1541-
href: '/docs/en/cloud/manage/service-types'
1541+
href: '/docs/en/cloud/manage'
15421542
},
15431543
{
15441544
type: 'link',
15451545
label: 'Security',
15461546
//description: 'Secure your ClickHouse Cloud services',
1547-
href: '/docs/en/cloud/security/shared-responsibility-model'
1547+
href: '/docs/en/cloud/security'
15481548
},
15491549
{
15501550
type: 'link',
15511551
label: 'Cloud API',
15521552
//description: 'Automate your ClickHouse Cloud services',
1553-
href: '/docs/en/cloud/manage/api/api-overview'
1553+
href: '/docs/en/cloud/manage/cloud-api'
15541554
},
15551555
{
15561556
type: 'link',

0 commit comments

Comments
 (0)