Merge pull request #2779 from Blargian/menu-improvement

Clickable breadcrumbs

.gitignore

@@ -40,4 +40,10 @@ FormatFactorySettingsDeclaration.h
 FormatFactorySettings.h
 Settings.cpp
 
+# Files whose content gets autogenerated
+docs/en/cloud/manage/api/invitations-api-reference.md
+docs/en/cloud/manage/api/keys-api-reference.md
+docs/en/cloud/manage/api/members-api-reference.md
+docs/en/cloud/manage/api/organizations-api-reference.md
+docs/en/cloud/manage/api/services-api-reference.md
 .vscode

docs/en/chdb/getting-started.md

@@ -147,7 +147,7 @@ This is fine to do with variables defined in your program, but don't do it with
 ## Configuring the output format
 
 The default output format is `CSV`, but we can change that via the `output_format` parameter. 
-chDB supports the ClickHouse data formats, as well as [some of its own](data-formats.md), including `DataFrame`, which returns a Pandas DataFrame:
+chDB supports the ClickHouse data formats, as well as [some of its own](/docs/en/chdb/reference/data-formats.md), including `DataFrame`, which returns a Pandas DataFrame:
 
 ```python
 result = chdb.query(

docs/en/chdb/guides/index.md

@@ -0,0 +1,13 @@
+---
+title: chDB Guides
+slug: /en/chdb/guides
+description: Index page for chDB guides
+keywords: [chdb, guides]
+---
+
+import TableOfContentsJSON from './table_of_contents.json'
+import { TableOfContents } from '/src/components/TableOfContents'
+
+Take a look at our chDB developer guides below:
+
+<TableOfContents items={TableOfContentsJSON} />

docs/en/chdb/guides/table_of_contents.json

@@ -0,0 +1,30 @@
+[
+    {
+        "title": "How to query Apache Arrow with chDB",
+        "slug": "/en/chdb/guides/apache-arrow"
+    },
+    {
+        "title": "How to query Pandas DataFrames with chDB",
+        "slug": "/en/chdb/guides/pandas"
+    },
+    {
+        "title": "How to query Parquet files",
+        "slug": "/en/chdb/guides/querying-parquet"
+    },
+    {
+        "title": "How to query a remote ClickHouse server",
+        "slug": "/en/chdb/guides/query-remote-clickhouse"
+    },
+    {
+        "title": "How to query data in an S3 bucket",
+        "slug": "/en/chdb/guides/querying-s3"
+    },
+    {
+        "title": "JupySQL and chDB",
+        "slug": "/en/chdb/guides/jupysql"
+    },
+    {
+        "title": "Using a clickhouse-local database",
+        "slug": "/en/chdb/guides/clickhouse-local"
+    }
+]

docs/en/chdb/install/index.md

@@ -0,0 +1,17 @@
+---
+title: Language Integrations Index
+slug: /en/chdb/install
+description: Index page for chDB language integrations
+keywords: [python, NodeJS, Go, Rust, Bun, C, C++]
+---
+
+Instructions for how to get setup with chDB are available below for the following languages and runtimes:
+
+| Language                               |
+|----------------------------------------|
+| [Python](/docs/en/chdb/install/python) |
+| [NodeJS](/docs/en/chdb/install/nodejs) |
+| [Go](/docs/en/chdb/install/go)         |
+| [Rust](/docs/en/chdb/install/rust)     |
+| [Bun](/docs/en/chdb/install/bun)       |
+| [C and C++](/docs/en/chdb/install/c)   |

docs/en/chdb/data-formats.md → docs/en/chdb/reference/data-formats.md

@@ -1,7 +1,7 @@
 ---
 title: Data Formats
 sidebar_label: Data Formats
-slug: /en/chdb/data-formats
+slug: /en/chdb/reference/data-formats
 description: Data Formats for chDB
 keywords: [chdb, data formats]
 ---

docs/en/chdb/reference/index.md

@@ -0,0 +1,11 @@
+---
+title: chDB Technical Reference
+slug: /en/chdb/reference
+description: Data Formats for chDB
+keywords: [chdb, data formats]
+---
+
+| Reference page       |
+|----------------------|
+| [Data Formats](/en/chdb/reference/data-formats)  |
+| [SQL Reference](/en/chdb/reference/sql-reference) |

docs/en/chdb/reference/sql-reference.md

@@ -0,0 +1,22 @@
+---
+title: SQL Reference
+sidebar_label: SQL Reference
+slug: /en/chdb/reference/sql-reference
+description: SQL Reference for chDB
+keywords: [chdb, sql reference]
+---
+
+chdb supports the same SQL syntax, statements, engines and functions as ClickHouse:
+
+| Topic                      |
+|----------------------------|
+| [SQL Syntax](/docs/en/sql-reference/syntax)          |
+| [Statements](/docs/en/sql-reference/statements)          |
+| [Table Engines](/docs/en/engines/table-engines)       |
+| [Database Engines](/docs/en/engines/database-engines)    |
+| [Regular Functions](/docs/en/sql-reference/functions)   |
+| [Aggregate Functions](/docs/en/sql-reference/aggregate-functions) |
+| [Table Functions](/docs/en/sql-reference/table-functions)     | 
+| [Window Functions](/docs/en/sql-reference/window-functions)    |
+
+For further information and examples, see the [ClickHouse SQL Reference](/docs/en/sql-reference).

docs/en/cloud/bestpractices/index.md

@@ -0,0 +1,19 @@
+---
+slug: /en/cloud/bestpractices
+keywords: [Cloud, Best Practices, Bulk Inserts, Asynchronous Inserts, Avoid Mutations, Avoid Nullable Columns, Avoid Optimize Final, Low Cardinality Partitioning Key]
+title: Overview
+hide_title: true
+---
+
+# Best Practices in ClickHouse
+
+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) |

docs/en/cloud/changelogs/table_of_contents.json

@@ -0,0 +1,18 @@
+[
+    {
+        "title": "v24.10 Changelog for Cloud",
+        "slug": "/en/changelogs/24.10"
+    },
+    {
+        "title": "v24.5 Changelog for Cloud",
+        "slug": "/en/changelogs/24.5"
+    },
+    {
+        "title": "v24.6 Changelog for Cloud",
+        "slug": "/en/changelogs/24.6"
+    },
+    {
+        "title": "v24.8 Changelog for Cloud",
+        "slug": "/en/changelogs/24.8"
+    }
+]

docs/en/get-started/cloud-quick-start.md → docs/en/cloud/get-started/cloud-quick-start.md

@@ -1,9 +1,9 @@
 ---
 sidebar_position: 1
-slug: /en/cloud-quick-start
+slug: /en/cloud/get-started/cloud-quick-start
 sidebar_label: Cloud Quick Start
 keywords: [clickhouse, install, getting started, quick start]
-pagination_next: en/get-started/sql-console
+pagination_next: en/cloud/get-started/sql-console
 ---
 import SignUp from '@site/docs/en/_snippets/_sign_in_or_trial.md';
 import SQLConsoleDetail from '@site/docs/en/_snippets/_launch_sql_console.md';

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

@@ -0,0 +1,18 @@
+---
+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]
+---
+
+Welcome to ClickHouse Cloud! Explore the pages below to learn more about what ClickHouse Cloud has to offer.
+
+| Page                     | Description                                                                                                                                               |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Overview](/docs/en/cloud/overview)          | Overview of the benefits of using ClickHouse Cloud and what version of ClickHouse is used for it.                                                         | 
+| [Cloud Quick Start](/docs/en/cloud/get-started/cloud-quick-start) | Quick start guide to get up and running with Cloud.                                                                                                       |
+| [SQL Console](/docs/en/cloud/get-started/sql-console)       | Learn about the interactive SQL console available in CLoud                                                                                                |
+| [Query Insights](/docs/en/cloud/get-started/query-insights)    | Learn about how Cloud's Query Insights feature makes ClickHouse's built-in query log easier to use through various visualizations and tables.             |
+| [Query Endpoints](/docs/en/cloud/get-started/query-endpoints)   | Learn about the Query API Endpoints feature which allows you to create an API endpoint directly from any saved SQL query in the ClickHouse Cloud console. |
+| [Dashboards](/docs/en/cloud/manage/dashboards)        | Learn about how SQL Console’s dashboards feature allows you to collect and share visualizations from saved queries.                                       |
+| [Cloud Support](/docs/en/cloud/support)     | Learn more about Support Services for ClickHouse Cloud users and customers.                                                                               |

docs/en/get-started/query-endpoints.md → docs/en/cloud/get-started/query-endpoints.md

@@ -1,6 +1,6 @@
 ---
 sidebar_title: Query API Endpoints
-slug: /en/get-started/query-endpoints
+slug: /en/cloud/get-started/query-endpoints
 description: Easily spin up REST API endpoints from your saved queries
 keywords: [api, query api endpoints, query endpoints, query rest api]
 ---
@@ -48,7 +48,7 @@ Next step, we'll go ahead and save the query:
 
 ![Save example query](@site/docs/en/cloud/images/sqlconsole/endpoints-savequery.png)
 
-More documentation around saved queries can be found [here](/docs/en/get-started/sql-console#saving-a-query).
+More documentation around saved queries can be found [here](/docs/en/cloud/get-started/sql-console#saving-a-query).
 
 ### Configuring the Query API Endpoint
 

docs/en/get-started/query-insights.md → docs/en/cloud/get-started/query-insights.md

@@ -1,6 +1,6 @@
 ---
 sidebar_title: Query Insights
-slug: /en/get-started/query-insights
+slug: /en/cloud/get-started/query-insights
 description: Visualize system.query_log data to simplify query debugging and performance optimization
 keywords: [query insights, query log, query log ui, system.query_log insights]
 ---
@@ -37,7 +37,7 @@ Selecting a query from the recent queries table will open a flyout containing me
 
 As we can see from the flyout, this particular query has been run more than 3000 times in the last 24 hours. All metrics in the **Query info** tab are aggregated metrics, but we can also view metrics from individual runs by selecting the **Query history** tab:
 
-<img src={require('../cloud/images/sqlconsole/insights_query_info.png').default}    
+<img src={require('@site/docs/en/cloud/images/sqlconsole/insights_query_info.png').default}    
   class="image"
   alt="Query Insights UI Query Information"
   style={{width: '400px'}} />

docs/en/get-started/sql-console.md → docs/en/cloud/get-started/sql-console.md

@@ -1,6 +1,6 @@
 ---
 sidebar_title: SQL Console
-slug: /en/get-started/sql-console
+slug: /en/cloud/get-started/sql-console
 description: Run queries and create visualizations using the SQL Console.
 keywords: [sql console, sql client, cloud console, console]
 ---
@@ -133,44 +133,44 @@ To save a query, simply click the "Save" button immediately next to the "Run" bu
 Using the shortcut cmd / ctrl + s will also save any work in the current query tab.
 :::
 
-![Save query](../images/sql-console-save-query.png)
+![Save query](@site/docs/en/images/sql-console-save-query.png)
 
 Alternatively, you can simultaneously name and save a query by clicking on "Untitled Query" in the toolbar, adjusting the name, and hitting Enter:
 
-![Rename query](../images/sql-console-rename.png)
+![Rename query](../../images/sql-console-rename.png)
 
 ### Query Sharing
 
 The SQL console allows you to easily share queries with your team members. The SQL console supports four levels of access that can be adjusted both globally and on a per-user basis:
 
 - Owner (can adjust sharing options)
 - Write access
-- Read only access
+- Read-only access
 - No access
 
 After saving a query, click the "Share" button in the toolbar. A modal with sharing options will appear:
 
-![Share query](../images/sql-console-share.png)
+![Share query](../../images/sql-console-share.png)
 
 To adjust query access for all organization members with access to the service, simply adjust the access level selector in the top line:
 
-![Edit access](../images/sql-console-edit-access.png)
+![Edit access](../../images/sql-console-edit-access.png)
 
 After applying the above, the query can now be viewed (and executed) by all team members with access to the SQL console for the service.
 
 To adjust query access for specific members, select the desired team member from the "Add a team member" selector:
 
-![Add team member](../images/sql-console-add-team.png)
+![Add team member](../../images/sql-console-add-team.png)
 
 After selecting a team member, a new line item should appear with an access level selector:
 
-![Edit team member access](../images/sql-console-edit-member.png)
+![Edit team member access](../../images/sql-console-edit-member.png)
 
 ### Accessing Shared Queries
 
 If a query has been shared with you, it will be displayed in the "Queries" tab of the SQL console left sidebar:
 
-![Access queries](../images/sql-console-access-queries.png)
+![Access queries](../../images/sql-console-access-queries.png)
 
 ### Linking to a query (permalinks)
 

docs/en/cloud/manage/api/api-reference-index.md

@@ -0,0 +1,12 @@
+---
+title: Cloud API
+slug: /en/cloud/manage/api/
+---
+
+| Page               | Description                      |
+|--------------------|----------------------------------|
+| [Invitations](/docs/en/cloud/manage/api/invitations-api-reference) | API reference for invitations.   |
+| [Keys](/docs/en/cloud/manage/api/keys-api-reference)        | API reference for keys.          |
+| [Members](/docs/en/cloud/manage/api/members-api-reference)      | API reference for requests.      |
+| [Organizations](/docs/en/cloud/manage/api/organizations-api-reference) | API reference for organizations. |
+| [Services](/docs/en/cloud/manage/api/services-api-reference)   | API reference for services.      |

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

@@ -0,0 +1,10 @@
+---
+title: Cloud API
+slug: en/cloud/manage/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.                                                                                                         |

docs/en/cloud/manage/api/invitations-api-reference.md

@@ -5,5 +5,5 @@ title: Invitations
 
 ## List all invitations
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
-content needs changing please edit `clickhouseapi.js`.
+This file is generated by `clickhouseapi.js` during the build process.  If the
+content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/keys-api-reference.md

@@ -5,5 +5,5 @@ title: Keys
 
 ## Get list of all keys
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
-content needs changing please edit `clickhouseapi.js`.
+This file is generated by `clickhouseapi.js` during the build process.  If the
+content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/members-api-reference.md

@@ -5,5 +5,5 @@ title: Members
 
 ## List organization members
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
-content needs changing please edit `clickhouseapi.js`.
+This file is generated by `clickhouseapi.js` during the build process.  If the
+content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/organizations-api-reference.md

@@ -5,5 +5,5 @@ title: Organizations
 
 ## Get organization details
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
-content needs changing please edit `clickhouseapi.js`.
+This file is generated by `clickhouseapi.js` during the build process.  If the
+content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/services-api-reference.md

@@ -5,5 +5,5 @@ title: Services
 
 ## List of organization services
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
-content needs changing please edit `clickhouseapi.js`.
+This file is generated by `clickhouseapi.js` during the build process.  If the
+content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/billing.md

@@ -1,6 +1,6 @@
 ---
 sidebar_label: Overview
-slug: /en/manage/billing
+slug: /en/cloud/manage/billing/overview
 title: Billing
 ---