add landing pages to additional pages

Blargian · Jan 12, 2025 · 892eb92 · 892eb92
1 parent 21844ff
commit 892eb92
Show file tree

Hide file tree

Showing 12 changed files with 109 additions and 35 deletions.
diff --git a/docs/en/cloud/security/index.md b/docs/en/cloud/security/index.md
@@ -16,4 +16,4 @@ This section delves into security in ClickHouse Cloud and contains the following
 | [Connectivity](.)                                                            | Information on setting IP filters, private networking, secure access of S3 data and Cloud IP addresses.                   |
 | [Customer Managed Encryption Keys](.)                                        | Information about how customers can leverage their own Key Management Service (KMS) key.                                  |
 | [Audit Logging](en/cloud/security/audit-logging)                             | A guide to audit logging in ClickHouse Cloud.                                                                             |
-| [Privacy and Compliance](.)                                                  | Information on security and compliance of CLickHouse Cloud, a guide on how to view and correct your personal information. |
+| [Privacy and Compliance](.)                                                  | Information on security and compliance of ClickHouse Cloud, a guide on how to view and correct your personal information. |
diff --git a/docs/en/guides/best-practices/index.md b/docs/en/guides/best-practices/index.md
@@ -10,6 +10,7 @@ This section covers the following topics:
 
 | Topic                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                             |
 |---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Overview](/docs/en/optimize)                                                                          | Provides an overview and suggested reading before working through this section of the docs.                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                             |
 | [Analyzer](/docs/en/operations/analyzer)                                              | Looks at the ClickHouse Analyzer, a tool for analyzing and optimizing queries. Discusses how the Analyzer works, its benefits (e.g., identifying performance bottlenecks), and how to use it to improve your ClickHouse queries' efficiency.                                                                                                                            |
 | [Asynchronous Inserts](/docs/en/optimize/asynchronous-inserts)                        | Focuses on ClickHouse's asynchronous inserts feature. It likely explains how asynchronous inserts work (batching data on the server for efficient insertion) and their benefits (improved performance by offloading insert processing). It might also cover enabling asynchronous inserts and considerations for using them effectively in your ClickHouse environment. |
 | [Avoid Mutations](/docs/en/optimize/avoid-mutations)                                  | Discusses the importance of avoiding mutations (updates and deletes) in ClickHouse. It recommends using append-only inserts for optimal performance and suggests alternative approaches for handling data changes.                                                                                                                                                      |
@@ -21,4 +22,4 @@ This section covers the following topics:
 | [Sparse Primary Indexes](/docs/en/optimize/sparse-primary-indexes)                    | Discusses sparse primary indexes in ClickHouse which are used to significantly accelerate query execution.                                                                                                                                                                                                                                                              |
 | [Query Profiling](/docs/en/operations/optimizing-performance/sampling-query-profiler) | Explains ClickHouse's Sampling Query Profiler, a tool that helps analyze query execution.                                                                                                                                                                                                                                                                               |
 | [Testing Hardware](/docs/en/operations/performance-test)                              | How to run a basic ClickHouse performance test on any server without installation of ClickHouse packages. (Not applicable to ClickHouse Cloud)                                                                                                                                                                                                                          |
-| [Query Cache](/docs/en/operations/query-cache)                                                                       | Details ClickHouse's Query Cache, a feature that aims to improve performance by caching the results of frequently executed `SELECT` queries.                                                                                                                                                                                                                            |
+| [Query Cache](/docs/en/operations/query-cache)                                        | Details ClickHouse's Query Cache, a feature that aims to improve performance by caching the results of frequently executed `SELECT` queries.                                                                                                                                                                                                                            |
diff --git a/docs/en/integrations/migration/index.md b/docs/en/integrations/migration/index.md
@@ -2,29 +2,19 @@
 sidebar_label: Overview
 sidebar_position: 1
 keywords: [clickhouse, migrate, migration, migrating, data]
+description: Migrating To Cloud Table Of Contents
+title: Migrating To Cloud
 ---
 
-# Migrating Data into ClickHouse
+This section of the docs explores how you can migrate from ClickHouse to ClickHouse Cloud.
+Take a look at the pages below for further information.
 
-<div class='vimeo-container'>
-  <iframe src="https://player.vimeo.com/video/753082620?h=eb566c8c08"
-    width="640"
-    height="360"
-    frameborder="0"
-    allow="autoplay;
-    fullscreen;
-    picture-in-picture"
-    allowfullscreen>
-  </iframe>
-</div>
-
-<br/>
-
-There are several options for migrating data into ClickHouse Cloud, depending on where your data resides now:
-
-- [Self-managed to Cloud](./clickhouse-to-cloud.md): use the `remoteSecure` function to transfer data
-- [Another DBMS](./clickhouse-local-etl.md): use the [clickhouse-local] ETL tool along with the appropriate ClickHouse table function for your current DBMS
-- [Anywhere!](./etl-tool-to-clickhouse.md): use one of the many popular ETL/ELT tools that connect to all kinds of different data sources
-- [Object Storage](./object-storage-to-clickhouse.md): easily insert data from S3 into ClickHouse
-
-In the example [Migrate from Redshift](/docs/en/integrations/data-ingestion/redshift/index.md), we present three different ways to migrate data to ClickHouse.
+| Page                                                                                               | Description                                                                                                                                               |
+|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Overview](/docs/en/integrations/migration/overview)                                               | Provides an overview of the available ways to migrate from ClickHouse to ClickHouse Cloud                                                                 |
+| [Migrating to ClickHouse using clickhouse-local](/docs/en/cloud/migration/clickhouse-local)        | Learn how to migrate to ClickHouse using clickhouse-local.                                                                                                |                                                                                                |
+| [ClickHouse to ClickHouse Cloud](/docs/en/cloud/migration/clickhouse-to-cloud)                     | This guide will show how to migrate from a self-managed ClickHouse server to ClickHouse Cloud, and also how to migrate between ClickHouse Cloud services. |
+| [Using a 3rd-party ETL Tool](/docs/en/cloud/migration/etl-tool-to-clickhouse)                      | Learn more about the popular ETL and ELT tools for moving data from an external data source into ClickHouse.                                              |
+| [Object Storage to ClickHouse Cloud](/docs/en/integrations/migration/object-storage-to-clickhouse) | Learn how to use various table functions to import data from Cloud Object Storage into ClickHouse Cloud.                                                  |
+| [Upload a CSV File](/docs/en/integrations/migration/upload-a-csv-file)                             | Learn how to upload data to ClickHouse Cloud using a CSV or TSV file.                                                                                     |
+| [Migrating From Rocksset](/docs/en/migrations/rockset)                                             | Learn how to migrate from Rockset to ClickHouse Cloud.                                                                                                    |
diff --git a/docs/en/integrations/migration/overview.md b/docs/en/integrations/migration/overview.md
@@ -0,0 +1,30 @@
+---
+sidebar_label: Overview
+sidebar_position: 1
+keywords: [clickhouse, migrate, migration, migrating, data]
+---
+
+# Migrating Data into ClickHouse
+
+<div class='vimeo-container'>
+  <iframe src="https://player.vimeo.com/video/753082620?h=eb566c8c08"
+    width="640"
+    height="360"
+    frameborder="0"
+    allow="autoplay;
+    fullscreen;
+    picture-in-picture"
+    allowfullscreen>
+  </iframe>
+</div>
+
+<br/>
+
+There are several options for migrating data into ClickHouse Cloud, depending on where your data resides now:
+
+- [Self-managed to Cloud](./clickhouse-to-cloud.md): use the `remoteSecure` function to transfer data
+- [Another DBMS](./clickhouse-local-etl.md): use the [clickhouse-local] ETL tool along with the appropriate ClickHouse table function for your current DBMS
+- [Anywhere!](./etl-tool-to-clickhouse.md): use one of the many popular ETL/ELT tools that connect to all kinds of different data sources
+- [Object Storage](./object-storage-to-clickhouse.md): easily insert data from S3 into ClickHouse
+
+In the example [Migrate from Redshift](/docs/en/integrations/data-ingestion/redshift/index.md), we present three different ways to migrate data to ClickHouse.
diff --git a/docs/en/managing-data/core-concepts/index.md b/docs/en/managing-data/core-concepts/index.md
@@ -0,0 +1,15 @@
+---
+slug: /en/concepts
+title: Core Concepts
+description: Learn Core Concepts of how ClickHouse works
+keywords: [concepts, part, partition, primary index]
+---
+
+In this section of the documentation,
+you will learn some of the core concepts of how ClickHouse works.
+
+| Page                                                        | Description                                                                                                                                                                                                           |
+|-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Table parts](/docs/en/parts)                               | Learn what table parts are in ClickHouse.                                                                                                                                                                             |
+| [Table partitions](/docs/en/partitions)                     | Learn what table partitions are and what they are used for.                                                                                                                                                           |
+| [Primary indexes](/docs/en/optimize/sparse-primary-indexes) | A deep dive into ClickHouse indexing including how it differs from other DB systems, how ClickHouse builds and uses a table's spare primary index and what some of the best practices are for indexing in ClickHouse. |
diff --git a/docs/en/managing-data/delete_mutations.md → ...ng-data/deleting-data/delete_mutations.md b/docs/en/managing-data/delete_mutations.md → ...ng-data/deleting-data/delete_mutations.md
diff --git a/docs/en/managing-data/deleting-data/index.md b/docs/en/managing-data/deleting-data/index.md
@@ -0,0 +1,18 @@
+---
+slug: /en/managing-data/deleting-data/overview
+title: Deleting Data
+description: How to delete data in ClickHouse Table Of Contents
+keywords: [delete, truncate, drop, lightweight delete]
+---
+
+In this section of the documentation,
+we will explore how to delete data in ClickHouse.
+
+| Page                                                                | Description                                                                                                                  |
+|---------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
+| [Overview](/docs/en/deletes/overview)                               | Provides an overview of the various ways to delete data in ClickHouse.                                                       |
+| [Lightweight Deletes](/docs/en/guides/developer/lightweight-delete) | Learn how to use the Lightweight Delete to delete data.                                                                      |
+| [Delete Mutations](/docs/en/managing-data/delete_mutations)         | Learn about Delete Mutations.                                                                                                |
+| [Truncate Table](/docs/en/managing-data/truncate)                   | Learn about how to use Truncate, which allows the data in a table or database to be removed, while preserving its existence. |
+| [Drop Partitions](/docs/en/managing-data/drop_partition)            | Learn about Dropping Partitions in ClickHouse.                                                                               |
+
diff --git a/docs/en/managing-data/deletes.md → ...n/managing-data/deleting-data/overview.md b/docs/en/managing-data/deletes.md → ...n/managing-data/deleting-data/overview.md
@@ -1,6 +1,6 @@
 ---
-slug: /en/deletes
-title: Deleting Data
+slug: /en/deletes/overview
+title: Overview
 description: How to delete data in ClickHouse
 keywords: [delete, truncate, drop, lightweight delete]
 ---

diff --git a/docs/en/managing-data/updating-data/index.md b/docs/en/managing-data/updating-data/index.md
@@ -0,0 +1,15 @@
+---
+slug: /en/updating-data
+title: Updating Data
+description: Updating Data Table Of Contents
+keywords: [update, updating data]
+---
+
+In this section of the documentation, you will learn how you can update your data.
+
+| Page                                                                 | Description                                                                                                                                                      |
+|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Overview](/docs/en/updating-data/overview)                          | Provides an overview of the differences in updating data between ClickHouse and OLTP databases, as well as the various methods available to do so in ClickHouse. |
+| [Update Mutations](/docs/en/managing-data/update_mutations)          | Learn how to update using Update Mutations.                                                                                                                      |
+| [Lightweight Updates](/docs/en/guides/developer/lightweight-update)  | Learn how to update using Lightweight Updates.                                                                                                                   |
+| [ReplacingMergeTree](/docs/en/guides/replacing-merge-tree)           | Learn how to update using the ReplacingMergeTree.                                                                                                                |
diff --git a/docs/en/managing-data/updates-index.md → ...n/managing-data/updating-data/overview.md b/docs/en/managing-data/updates-index.md → ...n/managing-data/updating-data/overview.md
@@ -1,6 +1,6 @@
 ---
-slug: /en/updating-data
-title: Updating Data
+slug: /en/updating-data/overview
+title: Overview
 description: How to update data in ClickHouse
 keywords: [update, updating data]
 ---

diff --git a/docs/en/managing-data/update_mutations.md → ...ng-data/updating-data/update_mutations.md b/docs/en/managing-data/update_mutations.md → ...ng-data/updating-data/update_mutations.md
diff --git a/sidebars.js b/sidebars.js
@@ -399,6 +399,7 @@ const sidebars = {
       collapsible: false,
       link: {type: "doc", id: "en/integrations/migration/index"},
       items: [
+        "en/integrations/migration/overview",
         "en/integrations/migration/clickhouse-to-cloud",
         "en/integrations/migration/clickhouse-local-etl",
         "en/integrations/migration/etl-tool-to-clickhouse",
@@ -922,9 +923,10 @@ const sidebars = {
   managingData: [
     {
       type: "category",
-      label: "Core concepts",
+      label: "Core Concepts",
       collapsed: false,
       collapsible: false,
+      link: {type: "doc", id: "en/managing-data/core-concepts/index"},
       items: [
         "en/managing-data/core-concepts/parts",
         "en/managing-data/core-concepts/partitions",
@@ -936,9 +938,10 @@ const sidebars = {
       label: "Updating Data",
       collapsed: false,
       collapsible: false,
-      link: {type: "doc", id: "en/managing-data/updates-index"},
+      link: {type: "doc", id: "en/managing-data/updating-data/index"},
       items: [
-        "en/managing-data/update_mutations",
+        "en/managing-data/updating-data/overview",
+        "en/managing-data/updating-data/update_mutations",
         {
           type: "doc",
           label: "Lightweight Updates",
@@ -956,14 +959,15 @@ const sidebars = {
       label: "Deleting Data",
       collapsed: false,
       collapsible: false,
-      link: {type: "doc", id: "en/managing-data/deletes"},
+      link: {type: "doc", id: "en/managing-data/deleting-data/index"},
       items: [
+        "en/managing-data/deleting-data/overview",
         {
           type: "doc",
           label: "Lightweight Deletes",
           id: "en/guides/developer/lightweight-delete"
         },
-        "en/managing-data/delete_mutations",
+        "en/managing-data/deleting-data/delete_mutations",
         "en/managing-data/truncate",
         "en/managing-data/drop_partition",
       ]
@@ -1304,6 +1308,7 @@ const sidebars = {
       label: "Security and Authentication",
       collapsed: false,
       collapsible: false,
+      link: {type: "doc", id: "en/operations/security-and-authentication/index"},
       items: [
         "en/guides/sre/user-management/index",
         {
@@ -1599,7 +1604,7 @@ const sidebars = {
           type: 'link',
           label: 'Deleting Data',
           //description: 'Deleting data in ClickHouse',
-          href: '/docs/en/deletes'
+          href: '/docs/en/managing-data/deleting-data/overview'
         },
         {
           type: 'link',