From 043a560e1b18f46b3d45909182925fde70895378 Mon Sep 17 00:00:00 2001 From: Shaun Struwig <41984034+Blargian@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:30:28 +0100 Subject: [PATCH] Fix remaining issues with breadcrumbs --- docs/en/cloud/bestpractices/index.md | 17 ++--- docs/en/cloud/get-started/index.md | 2 +- docs/en/cloud/manage/api/index.md | 14 ++-- .../privateEndpointConfig-api-reference.md | 39 ++++++++++ .../manage/api/prometheus-api-reference.md | 21 ++++++ docs/en/cloud/manage/billing/index.md | 14 ++-- docs/en/guides/best-practices/index.md | 5 +- .../en/integrations/language-clients/index.md | 19 +++++ docs/en/optimize/index.md | 8 --- docusaurus.config.js | 4 ++ sidebars.js | 12 ++-- src/theme/Navbar/Content/index.js | 72 +++++++++---------- 12 files changed, 155 insertions(+), 72 deletions(-) create mode 100644 docs/en/cloud/manage/api/privateEndpointConfig-api-reference.md create mode 100644 docs/en/cloud/manage/api/prometheus-api-reference.md create mode 100644 docs/en/integrations/language-clients/index.md delete mode 100644 docs/en/optimize/index.md diff --git a/docs/en/cloud/bestpractices/index.md b/docs/en/cloud/bestpractices/index.md index a6a983e3360..d42e4d2ca34 100644 --- a/docs/en/cloud/bestpractices/index.md +++ b/docs/en/cloud/bestpractices/index.md @@ -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) | \ No newline at end of file +| 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. | \ No newline at end of file diff --git a/docs/en/cloud/get-started/index.md b/docs/en/cloud/get-started/index.md index 75cc5af60fe..79a773df6f6 100644 --- a/docs/en/cloud/get-started/index.md +++ b/docs/en/cloud/get-started/index.md @@ -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] diff --git a/docs/en/cloud/manage/api/index.md b/docs/en/cloud/manage/api/index.md index b0ba91d5499..57e2a388755 100644 --- a/docs/en/cloud/manage/api/index.md +++ b/docs/en/cloud/manage/api/index.md @@ -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. | diff --git a/docs/en/cloud/manage/api/privateEndpointConfig-api-reference.md b/docs/en/cloud/manage/api/privateEndpointConfig-api-reference.md new file mode 100644 index 00000000000..8caa882a647 --- /dev/null +++ b/docs/en/cloud/manage/api/privateEndpointConfig-api-reference.md @@ -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" +} +``` diff --git a/docs/en/cloud/manage/api/prometheus-api-reference.md b/docs/en/cloud/manage/api/prometheus-api-reference.md new file mode 100644 index 00000000000..2ca165d3209 --- /dev/null +++ b/docs/en/cloud/manage/api/prometheus-api-reference.md @@ -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. | + diff --git a/docs/en/cloud/manage/billing/index.md b/docs/en/cloud/manage/billing/index.md index d41f76cde04..420be000066 100644 --- a/docs/en/cloud/manage/billing/index.md +++ b/docs/en/cloud/manage/billing/index.md @@ -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. | diff --git a/docs/en/guides/best-practices/index.md b/docs/en/guides/best-practices/index.md index 4488abda6d1..d3243294ab8 100644 --- a/docs/en/guides/best-practices/index.md +++ b/docs/en/guides/best-practices/index.md @@ -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 | |------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/en/integrations/language-clients/index.md b/docs/en/integrations/language-clients/index.md new file mode 100644 index 00000000000..e2d3277169c --- /dev/null +++ b/docs/en/integrations/language-clients/index.md @@ -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. | \ No newline at end of file diff --git a/docs/en/optimize/index.md b/docs/en/optimize/index.md deleted file mode 100644 index 54899f025a5..00000000000 --- a/docs/en/optimize/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -slug: /en/optimize -sidebar_label: Overview -title: Performance and Optimizations -hide_title: false ---- - -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). diff --git a/docusaurus.config.js b/docusaurus.config.js index 6274a7b6130..175b6790367 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -2389,6 +2389,10 @@ const config = { from: '/en/deletes', to: '/en/deletes/overview' }, + { + from: '/docs/en/optimize', + to: '/docs/en/operations/overview' + } ], }, ], diff --git a/sidebars.js b/sidebars.js index 93ebb89d4cb..2e03803b5ea 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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", @@ -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", @@ -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', diff --git a/src/theme/Navbar/Content/index.js b/src/theme/Navbar/Content/index.js index 163632c932d..78927a32a4a 100644 --- a/src/theme/Navbar/Content/index.js +++ b/src/theme/Navbar/Content/index.js @@ -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' - }, ] }, { @@ -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' } ] }, @@ -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', @@ -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', @@ -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' }, ] }, @@ -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' }, ] },