docs: merge docs/api_docs/install into docs/user_docs/ (#8109)

Co-authored-by: yuanyuan zhang <yuanyuan.zhang@apecloud.com> (cherry picked from commit 1a62bf2)
apecloud · Sep 10, 2024 · de319f3 · de319f3
1 parent 29ba5a3
commit de319f3
Show file tree

Hide file tree

Showing 44 changed files with 241 additions and 374 deletions.
diff --git a/docs/api_docs/installation/_category_.yml b/docs/api_docs/installation/_category_.yml
@@ -1,4 +0,0 @@
-position: 3
-label: Installation
-collapsible: true 
-collapsed: true 

diff --git a/...ecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md b/...ecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md
@@ -14,8 +14,8 @@ This tutorial shows how to create and connect to an ApeCloud MySQL cluster.
 
 ### Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
-* Make sure the `apecloud-mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
+* Make sure the `apecloud-mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition apecloud-mysql

diff --git a/docs/api_docs/kubeblocks-for-apecloud-mysql/configuration/configuration.md b/docs/api_docs/kubeblocks-for-apecloud-mysql/configuration/configuration.md
@@ -18,7 +18,7 @@ But it's also important to note that the dynamic parameter configuration doesn't
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. [Create an ApeCloud MySQL cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md).
 
 ## Configure cluster parameters by editing configuration file

diff --git a/docs/api_docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md b/docs/api_docs/kubeblocks-for-apecloud-mysql/high-availability/high-availability.md
@@ -21,7 +21,7 @@ The faults here are all simulated by deleting pods. When there are sufficient re
 
 ### Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * [Create an ApeCloud MySQL RaftGroup Cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md).
 * Run `kubectl get cd apecloud-mysql -o yaml` to check whether _rolechangedprobe_ is enabled in the ApeCloud MySQL RaftGroup Cluster (it is enabled by default). If the following configuration exists, it indicates that it is enabled:
 

diff --git a/docs/api_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md b/docs/api_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md
@@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. Prepare an ApeCloud MySQL RaftGroup named `mycluster` for demonstrating how to enable the proxy function for an existing cluster. Refer to [Create a MySQL cluster](./../cluster-management/create-and-connect-an-apecloud-mysql-cluster.md) for details.
 
 ## Create a Proxy Cluster

diff --git a/docs/api_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md b/docs/api_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md
@@ -17,10 +17,10 @@ KubeBlocks supports the management of Elasticsearch. This tutorial illustrates h
 
 ## Before you start
 
-* [Install KubeBlocks](./../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `elasticsearch` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
+  Make sure the `elasticsearch` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition elasticsearch

diff --git a/docs/api_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md b/docs/api_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md
@@ -15,10 +15,10 @@ This document shows how to create a Kafka cluster by `kubectl` or a YAML file.
 
 ## Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `kafka` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
+  Make sure the `kafka` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition kafka

diff --git a/docs/api_docs/kubeblocks-for-kafka/configuration/configuration.md b/docs/api_docs/kubeblocks-for-kafka/configuration/configuration.md
@@ -11,7 +11,7 @@ This guide shows how to configure cluster parameters.
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. [Create a Kafka cluster](./../cluster-management/create-a-kafka-cluster.md).
 
 ## Configure cluster parameters by editing configuration file

diff --git a/docs/api_docs/kubeblocks-for-milvus/manage-milvus.md b/docs/api_docs/kubeblocks-for-milvus/manage-milvus.md
@@ -19,10 +19,10 @@ This tutorial illustrates how to create and manage a Milvus cluster by `kubectl`
 
 ## Before you start
 
-* [Install KubeBlocks](./../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `milvus` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
+  Make sure the `milvus` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition milvus

diff --git a/...locks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md b/...locks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md
@@ -17,11 +17,11 @@ This tutorial shows how to create and connect to a MongoDB cluster.
 
 ### Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `mongodb` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
+  Make sure the `mongodb` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition mongodb

diff --git a/docs/api_docs/kubeblocks-for-mongodb/configuration/configuration.md b/docs/api_docs/kubeblocks-for-mongodb/configuration/configuration.md
@@ -11,7 +11,7 @@ This guide shows how to configure cluster parameters.
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. [Create a MongoDB cluster](./../cluster-management/create-and-connect-to-a-mongodb-cluster.md).
 
 ## Configure cluster parameters by configuration file

diff --git a/...ysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md b/...ysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md
@@ -14,10 +14,10 @@ This tutorial shows how to create and connect to a MySQL cluster.
 
 ### Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-* Make sure the `mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
+* Make sure the `mysql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition mysql

diff --git a/.../api_docs/kubeblocks-for-mysql-community-edition/configuration/configuration.md b/.../api_docs/kubeblocks-for-mysql-community-edition/configuration/configuration.md
@@ -18,7 +18,7 @@ But it's also important to note that the dynamic parameter configuration doesn't
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. [Create a MySQL cluster](./../cluster-management/create-and-connect-a-mysql-cluster.md).
 
 ## Configure cluster parameters by editing configuration file

diff --git a/...s/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md b/...s/kubeblocks-for-mysql-community-edition/high-availability/high-availability.md
@@ -21,7 +21,7 @@ The faults here are all simulated by deleting pods. When there are sufficient re
 
 ### Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * [Create a MySQL Replication Cluster](./../cluster-management/create-and-connect-a-mysql-cluster.md).
 * Run `kubectl get cd mysql -o yaml` to check whether _rolechangedprobe_ is enabled in the MySQL Replication Cluster (it is enabled by default). If the following configuration exists, it indicates that it is enabled:
 

diff --git a/...ks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md b/...ks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md
@@ -14,10 +14,10 @@ This tutorial shows how to create and connect to a PostgreSQL cluster.
 
 ### Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `postgresql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
+  Make sure the `postgresql` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition postgresql

diff --git a/docs/api_docs/kubeblocks-for-postgresql/configuration/configuration.md b/docs/api_docs/kubeblocks-for-postgresql/configuration/configuration.md
@@ -17,7 +17,7 @@ But it's also important to note that the dynamic parameter configuration doesn't
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. [Create a PostgreSQL cluster](./../cluster-management/create-and-connect-a-postgresql-cluster.md).
 
 ## Configure cluster parameters by editing configuration file

diff --git a/docs/api_docs/kubeblocks-for-postgresql/high-availability/high-availability.md b/docs/api_docs/kubeblocks-for-postgresql/high-availability/high-availability.md
@@ -11,7 +11,7 @@ KubeBlocks integrates [the open-source Patroni solution](https://patroni.readthe
 
 ## Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * [Create a PostgreSQL Replication Cluster](./../cluster-management/create-and-connect-a-postgresql-cluster.md#create-a-postgresql-cluster).
 * Check whether the following role probe parameters exist to verify the role probe is enabled.
 

diff --git a/...kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md b/...kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md
@@ -26,11 +26,11 @@ Refer to the [Pulsar official document](https://pulsar.apache.org/docs/3.1.x/) f
 
 ## Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `pulsar` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
+  Make sure the `pulsar` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition redis

diff --git a/docs/api_docs/kubeblocks-for-pulsar/configuration/configuration.md b/docs/api_docs/kubeblocks-for-pulsar/configuration/configuration.md
@@ -26,7 +26,7 @@ For Pulsar, there are 3 types of parameters:
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. [Create a Pulsar cluster](./../cluster-management/create-pulsar-cluster-on-kubeblocks.md).
 
 ## Configure cluster parameters by configuration file

diff --git a/docs/api_docs/kubeblocks-for-qdrant/manage-qdrant.md b/docs/api_docs/kubeblocks-for-qdrant/manage-qdrant.md
@@ -17,10 +17,10 @@ In this chapter, we take Qdrant as an example to show how to manage vector datab
 
 ## Before you start
 
-* [Install KubeBlocks](./../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `qdrant` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
+  Make sure the `qdrant` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition qdrant

diff --git a/...s/kubeblocks-for-redis/cluster-management/create-and-connect-a-redis-cluster.md b/...s/kubeblocks-for-redis/cluster-management/create-and-connect-a-redis-cluster.md
@@ -17,11 +17,11 @@ This tutorial shows how to create and connect to a Redis cluster.
 
 ### Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `redis` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../../installation/install-addons.md) to enable it first.
+  Make sure the `redis` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition redis

diff --git a/docs/api_docs/kubeblocks-for-redis/configuration/configuration.md b/docs/api_docs/kubeblocks-for-redis/configuration/configuration.md
@@ -12,7 +12,7 @@ This guide shows how to configure cluster parameters.
 
 ## Before you start
 
-1. [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+1. [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 2. [Create a Redis cluster](./../cluster-management/create-and-connect-a-redis-cluster.md).
 
 ## Configure cluster parameters by editing configuration file

diff --git a/docs/api_docs/kubeblocks-for-redis/high-availability/high-availability.md b/docs/api_docs/kubeblocks-for-redis/high-availability/high-availability.md
@@ -15,7 +15,7 @@ In the RedisReplication Cluster provided by KubeBlocks, Sentinel is deployed as
 
 ## Before you start
 
-* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * [Create a Redis Replication Cluster](./../cluster-management/create-and-connect-a-redis-cluster.md#create-a-redis-cluster).
 * Check the role probe.
   * Check whether the following role probe parameters exist to verify the role probe is enabled.

diff --git a/docs/api_docs/kubeblocks-for-redis/redis-cluster-mode.md b/docs/api_docs/kubeblocks-for-redis/redis-cluster-mode.md
@@ -30,7 +30,7 @@ Below is a brief introduction to the basic operations of Redis Cluster Mode.
 
 ### Before you start
 
-* [Install KubeBlocks](./../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
     Make sure your KubeBlocks and addon are version 0.9 or above.
 * Make sure the Redis addon is enabled.
 * View all the database types and versions available for creating a cluster.

diff --git a/docs/api_docs/kubeblocks-for-starrocks/manage-starrocks.md b/docs/api_docs/kubeblocks-for-starrocks/manage-starrocks.md
@@ -17,10 +17,10 @@ This tutorial illustrates how to create and manage a StarRocks cluster by `kubec
 
 ## Before you start
 
-* [Install KubeBlocks](./../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `starrocks` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
+  Make sure the `starrocks` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition starrocks

diff --git a/docs/api_docs/kubeblocks-for-weaviate/manage-weaviate.md b/docs/api_docs/kubeblocks-for-weaviate/manage-weaviate.md
@@ -17,10 +17,10 @@ This tutorial illustrates how to create and manage a Weaviate cluster by `kubect
 
 ## Before you start
 
-* [Install KubeBlocks](./../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `weaviate` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
+  Make sure the `weaviate` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition weaviate

diff --git a/docs/api_docs/kubeblocks-for-xinference/manage-xinference.md b/docs/api_docs/kubeblocks-for-xinference/manage-xinference.md
@@ -17,10 +17,10 @@ This tutorial illustrates how to create and manage a Xinference cluster by `kube
 
 ## Before you start
 
-* [Install KubeBlocks](./../installation/install-kubeblocks.md).
+* [Install KubeBlocks](../../user_docs/installation/install-with-helm/install-kubeblocks.md).
 * View all the database types and versions available for creating a cluster.
 
-  Make sure the `xinference` cluster definition is installed. If the cluster definition is not available, refer to [this doc](./../installation/install-addons.md) to enable it first.
+  Make sure the `xinference` cluster definition is installed. If the cluster definition is not available, refer to [this doc](../../user_docs/installation/install-with-helm/install-addons.md) to enable it first.
 
   ```bash
   kubectl get clusterdefinition xinference

diff --git a/docs/api_docs/maintenance/backup-and-restore/backup/backup-repo.md b/docs/api_docs/maintenance/backup-and-restore/backup/backup-repo.md
@@ -21,7 +21,7 @@ Make sure you have all the following prepared.
 
 * [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
 * [Install Helm](https://helm.sh/docs/intro/install/)
-* [Install KubeBlocks](./../../../installation/install-kubeblocks.md)
+* [Install KubeBlocks](../../../../user_docs/installation/install-with-helm/install-kubeblocks.md)
 
 ## Install MinIO