Skip to content

Commit

Permalink
Fix remaining issues with breadcrumbs
Browse files Browse the repository at this point in the history
  • Loading branch information
Blargian committed Jan 15, 2025
1 parent c69d21e commit 043a560
Show file tree
Hide file tree
Showing 12 changed files with 155 additions and 72 deletions.
17 changes: 9 additions & 8 deletions docs/en/cloud/bestpractices/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ hide_title: true

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

| Best Practice |
|------------------------------------------------------------------------------------------------------------|
| [Use Bulk Inserts](/docs/en/cloud/bestpractices/bulk-inserts) |
| [Asynchronous Inserts](/docs/en/cloud/bestpractices/asynchronous-inserts) |
| [Avoid Mutations](/docs/en/cloud/bestpractices/avoid-mutations) |
| [Avoid Nullable Columns](/docs/en/cloud/bestpractices/avoid-nullable-columns) |
| [Avoid Optimize Final](/docs/en/cloud/bestpractices/avoid-optimize-final) |
| [Choose a Low Cardinality Partitioning Key](/docs/en/cloud/bestpractices/low-cardinality-partitioning-key) |
| Page | Description |
|----------------------------------------------------------|----------------------------------------------------------------------------|
| [Use Bulk Inserts](/docs/en/cloud/bestpractices/bulk-inserts) | Learn why you should ingest data in bulk in ClickHouse |
| [Asynchronous Inserts](/docs/en/cloud/bestpractices/asynchronous-inserts) | Learn how to asynchronously insert data if bulk inserts are not an option. |
| [Avoid Mutations](/docs/en/cloud/bestpractices/avoid-mutations) | Learn why you should avoid mutations which trigger rewrites. |
| [Avoid Nullable Columns](/docs/en/cloud/bestpractices/avoid-nullable-columns) | Learn why you should ideally avoid Nullable columns |
| [Avoid Optimize Final](/docs/en/cloud/bestpractices/avoid-optimize-final) | Learn why you should avoid `OPTIMIZE TABLE ... FINAL` |
| [Choose a Low Cardinality Partitioning Key](/docs/en/cloud/bestpractices/low-cardinality-partitioning-key) | Learn how to choose a low cardinality partitioning key. |
| [Usage Limits](/docs/en/cloud/bestpractices/usage-limits)| Explore the limits of ClickHouse. |
2 changes: 1 addition & 1 deletion docs/en/cloud/get-started/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: en/cloud/get-started
slug: /en/cloud/get-started
title: Get Started
description: Get Started Table Of Contents
keywords: [Cloud Quick Start, SQL Console, Query Insights, Query API Endpoints, Dashboards, Cloud Support]
Expand Down
14 changes: 8 additions & 6 deletions docs/en/cloud/manage/api/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
title: Cloud API
slug: en/cloud/manage/api
slug: /en/cloud/manage/cloud-api
---

| Page | Description |
|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| [Overview](/docs/en/cloud/manage/api/api-overview) | Provides an overview of rate limits, Terraform Provider, Swagger (OpenAPI) Endpoint and UI and available support. |
| [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. |
| [API Reference](/docs/en/cloud/manage/api) | API reference documentation. |
This section contains reference documentation for Cloud API and contains the following pages:

| Page | Description |
|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| [Overview](/docs/en/cloud/manage/api/api-overview)| Provides an overview of rate limits, Terraform Provider, Swagger (OpenAPI) Endpoint and UI and available support. |
| [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. |
| [API Reference](/docs/en/cloud/manage/api) | API reference documentation. |
39 changes: 39 additions & 0 deletions docs/en/cloud/manage/api/privateEndpointConfig-api-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
sidebar_label: PrivateEndpointConfig
title: PrivateEndpointConfig
---

## Get private endpoint configuration for region within cloud provider for an organization

Information required to set up a private endpoint

| Method | Path |
| :----- | :--- |
| GET | `/v1/organizations/{organizationId}/privateEndpointConfig` |

### Request

#### Path Params

| Name | Type | Description |
| :--- | :--- | :---------- |
| organizationId | uuid | ID of the requested organization. |
| Cloud provider identifier | string | Cloud provider identifier. One of aws, gcp, or azure. |
| Cloud provider region | string | Region identifier within specific cloud providers. |


### Response

#### Response Schema

| Name | Type | Description |
| :--- | :--- | :---------- |
| endpointServiceId | string | Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource |

#### Sample response

```
{
"endpointServiceId": "string"
}
```
21 changes: 21 additions & 0 deletions docs/en/cloud/manage/api/prometheus-api-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_label: Prometheus
title: Prometheus
---

## Get organization details

Returns details of a single organization. In order to get the details, the auth key must belong to the organization.

| Method | Path |
| :----- | :--- |
| GET | `/v1/organizations/{organizationId}/prometheus` |

### Request

#### Path Params

| Name | Type | Description |
| :--- | :--- | :---------- |
| organizationId | uuid | ID of the requested organization. |

14 changes: 8 additions & 6 deletions docs/en/cloud/manage/billing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ description: Table of contents page for billing.
keywords: [billing, payment thresholds, trouble shooting, marketplace]
---

| Page |
|----------------------------------------------------------------------------------|
| [Overview](/docs/en/cloud/marketplace/marketplace-billing) |
| [Payment Thresholds](/docs/en/cloud/billing/payment-thresholds) |
| [Troubleshooting Billing Issues](/docs/en/manage/troubleshooting-billing-issues) |
| [Marketplace](/docs/en/cloud/manage/) |
This section of the documentation covers topics related to billing, and contains the following pages:

| Page | Description |
|---------------------------------------|-----------------------------------------------------------------------|
| [Overview](/docs/en/cloud/marketplace/marketplace-billing) | Overview and FAQ page for marketplace billing. |
| [Payment Thresholds](/docs/en/cloud/billing/payment-thresholds) | Learn more about how payment threshholds work and how to adjust them. |
| [Troubleshooting Billing Issues](/docs/en/manage/troubleshooting-billing-issues) | Troubleshoot common billing issues. |
| [Marketplace](/docs/en/cloud/manage/) | Landing page for further marketplace related topics. |
5 changes: 4 additions & 1 deletion docs/en/guides/best-practices/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ description: Overview page of Performance and Optimizations

# Performance and Optimizations

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

| Topic | Description |
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
19 changes: 19 additions & 0 deletions docs/en/integrations/language-clients/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
slug: /en/integrations/language-clients
title: Language Clients
description: Table of contents page for Language Clients.
keywords: [Language Clients, C++, Go, Javascript, Java, Python, Rust]
---

In this section of the documentation, you can learn more about the many language client integrations
that ClickHouse offers.

| Page | Description |
|-------------------------------------------------------------------------|----------------------------------------------------------------------------------|
| [C++](/docs/en/interfaces/cpp) | C++ Client Library and userver Asynchronous Framework |
| [Go](/docs/en/integrations/go) | Learn how to connect your Go projects to ClickHouse. |
| [Javascript](/docs/en/integrations/javascript) | Learn how to connect your JS projects to ClickHouse with the official JS client. |
| [Java](/docs/en/integrations/java) | Learn more about several integrations for Java and ClickHouse. |
| [Python](/docs/en/integrations/python) | Learn how to connect your Python projects to ClickHouse. |
| [Rust](/docs/en/integrations/rust) | Learn how to connect your Rust projects to ClickHouse. |
| [Third-party clients](/docs/en/interfaces/third-party/client-libraries) | Learn more about client libraries from third party developers. |
8 changes: 0 additions & 8 deletions docs/en/optimize/index.md

This file was deleted.

4 changes: 4 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2389,6 +2389,10 @@ const config = {
from: '/en/deletes',
to: '/en/deletes/overview'
},
{
from: '/docs/en/optimize',
to: '/docs/en/operations/overview'
}
],
},
],
Expand Down
12 changes: 6 additions & 6 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,7 @@ const sidebars = {
label: "Language Clients",
collapsed: false,
collapsible: false,
link: {type: "doc", id: "en/integrations/language-clients/index"},
items: [
"en/interfaces/cpp",
"en/integrations/language-clients/go/index",
Expand Down Expand Up @@ -1049,7 +1050,6 @@ const sidebars = {
collapsible: false,
link: {type: "doc", id: "en/guides/best-practices/index"},
items: [
"en/optimize/index",
"en/operations/analyzer",
"en/guides/best-practices/asyncinserts",
"en/guides/best-practices/avoidmutations",
Expand Down Expand Up @@ -1551,31 +1551,31 @@ const sidebars = {
type: 'link',
label: 'Get Started',
//description: 'Start quickly with ClickHouse Cloud',
href: '/docs/en/cloud/overview'
href: '/docs/en/cloud/get-started/'
},
{
type: 'link',
label: 'Best Practices',
//description: 'How to get the most out of ClickHouse Cloud',
href: '/docs/en/cloud/bestpractices/bulk-inserts'
href: '/docs/en/cloud/bestpractices'
},
{
type: 'link',
label: 'Managing Cloud',
//description: 'Manage your ClickHouse Cloud services',
href: '/docs/en/cloud/manage/service-types'
href: '/docs/en/cloud/manage'
},
{
type: 'link',
label: 'Security',
//description: 'Secure your ClickHouse Cloud services',
href: '/docs/en/cloud/security/shared-responsibility-model'
href: '/docs/en/cloud/security'
},
{
type: 'link',
label: 'Cloud API',
//description: 'Automate your ClickHouse Cloud services',
href: '/docs/en/cloud/manage/api/api-overview'
href: '/docs/en/cloud/manage/cloud-api'
},
{
type: 'link',
Expand Down
72 changes: 36 additions & 36 deletions src/theme/Navbar/Content/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,38 +87,38 @@ const dropdownCategories = [{
{
title: 'Get Started',
description: 'Start quickly with ClickHouse Cloud',
link: '/docs/en/cloud/get-started/cloud-quick-start'
},
{
title: 'Best Practices',
description: 'How to get the most out of ClickHouse Cloud',
link: '/docs/en/cloud/bestpractices/bulk-inserts'
link: '/docs/en/cloud/get-started/'
},
{
title: 'Managing Cloud',
description: 'Manage your ClickHouse Cloud services',
link: '/docs/en/cloud/manage/service-types'
},
{
title: 'Security',
description: 'Secure your ClickHouse Cloud services',
link: '/docs/en/cloud/security/shared-responsibility-model'
link: '/docs/en/cloud/manage/'
},
{
title: 'Cloud API',
description: 'Automate your ClickHouse Cloud services',
link: '/docs/en/cloud/manage/api/api-overview'
link: '/docs/en/cloud/manage/cloud-api/'
},
{
title: 'Cloud Reference',
description: 'Understanding how ClickHouse Cloud works',
link: '/docs/en/cloud/reference/'
},
{
title: 'Best Practices',
description: 'How to get the most out of ClickHouse Cloud',
link: '/docs/en/cloud/bestpractices/'
},
{
title: 'Security',
description: 'Secure your ClickHouse Cloud services',
link: '/docs/en/cloud/security/'
},
{
title: 'Migrating to Cloud',
description: 'Migrate your database to ClickHouse Cloud',
link: '/docs/en/integrations/migration'
},
{
title: 'Cloud Reference',
description: 'Understanding how ClickHouse Cloud works',
link: '/docs/en/cloud/reference/architecture'
},
]
},
{
Expand All @@ -130,27 +130,27 @@ const dropdownCategories = [{
{
title: 'Core Data Concepts',
description: 'Understand internal concepts in ClickHouse',
link: '/docs/en/parts'
link: '/docs/en/concepts'
},
{
title: 'Updating Data',
description: 'Updating and replacing data in ClickHouse',
link: '/docs/en/updating-data'
},
{
title: 'Data Modeling',
description: 'Optimize your schema and data model',
link: '/docs/en/data-modeling/schema-design'
},
{
title: 'Deleting Data',
description: 'Deleting data in ClickHouse',
link: '/docs/en/deletes'
link: '/docs/en/managing-data/deleting-data/overview'
},
{
title: 'Data Modeling',
description: 'Optimize your schema and data model',
link: '/docs/en/data-modeling/overview'
},
{
title: 'Performance and Optimizations',
description: 'Guides to help you optimize ClickHouse',
link: '/docs/en/optimize'
link: '/docs/en/operations/overview'
}
]
},
Expand Down Expand Up @@ -229,7 +229,7 @@ const dropdownCategories = [{
{
title: 'Language Clients',
description: 'Use your favorite language to work with ClickHouse',
link: '/docs/en/integrations/go'
link: '/docs/en/integrations/language-clients'
},
{
title: 'ClickPipes',
Expand All @@ -239,12 +239,12 @@ const dropdownCategories = [{
{
title: 'Native Clients & Interfaces',
description: 'Choose a client and interface to connect to ClickHouse',
link: '/docs/en/interfaces/cli'
link: '/docs/en/interfaces/natives-clients-and-interfaces'
},
{
title: 'Data Sources',
description: 'Load data into ClickHouse from your prefered source',
link: '/docs/en/integrations/s3'
link: '/docs/en/integrations/index'
},
{
title: 'Data Visualization',
Expand All @@ -259,7 +259,7 @@ const dropdownCategories = [{
{
title: 'Data Ingestion',
description: 'Ingest data into ClickHouse with a range of ELT tools',
link: '/docs/en/integrations/airbyte'
link: '/docs/en/integrations/data-ingestion-overview'
},
]
},
Expand All @@ -274,15 +274,15 @@ const dropdownCategories = [{
description: 'Learn how to use chDB',
link: '/docs/en/chdb'
},
{
title: 'Guides',
description: 'Guides to help you use chDB',
link: '/docs/en/chdb/guides/jupysql'
},
{
title: 'Language Integrations',
description: 'Connect to chDB using a language client',
link: '/docs/en/chdb/install/python'
link: '/docs/en/chdb/install'
},
{
title: 'Guides',
description: 'Guides to help you use chDB',
link: '/docs/en/chdb/guides'
},
]
},
Expand Down

0 comments on commit 043a560

Please sign in to comment.