From 52ac66eb34fe8e0b7676edc182bfbaf947e1ae40 Mon Sep 17 00:00:00 2001 From: shenying1023 <143054567+shenying1023@users.noreply.github.com> Date: Wed, 6 Mar 2024 14:05:19 +0800 Subject: [PATCH] docs: adjust en docs format (#6760) --- .../cluster-management/create-a-kafka-cluster.md | 3 +++ .../kubeblocks-for-mongodb/cluster-management/switchover.md | 3 +++ .../cluster-management/restart-a-postgresql-cluster.md | 2 +- .../cluster-management/create-pulsar-cluster-on-kubeblocks.md | 4 ++-- .../kubeblocks-for-vector-database/manage-vector-databases.md | 1 + 5 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md b/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md index 7af346f1f3a..92ae1f1b02f 100644 --- a/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md +++ b/docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md @@ -6,6 +6,9 @@ sidebar_position: 1 sidebar_label: Create --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # Create a Kafka cluster This document shows how to create a Kafka cluster. diff --git a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md index 87598ff75e4..8471456c57d 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md +++ b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md @@ -6,6 +6,9 @@ sidebar_position: 6 sidebar_label: Switchover --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # Switch over a MongoDB cluster You can initiate a switchover for a MongoDB ReplicaSet by executing the kbcli or kubectl command. Then KubeBlocks modifies the instance roles. diff --git a/docs/user_docs/kubeblocks-for-postgresql/cluster-management/restart-a-postgresql-cluster.md b/docs/user_docs/kubeblocks-for-postgresql/cluster-management/restart-a-postgresql-cluster.md index 904bc06ba93..6517c012dd8 100644 --- a/docs/user_docs/kubeblocks-for-postgresql/cluster-management/restart-a-postgresql-cluster.md +++ b/docs/user_docs/kubeblocks-for-postgresql/cluster-management/restart-a-postgresql-cluster.md @@ -21,7 +21,7 @@ Restarting a PostgreSQL cluster triggers a concurrent restart and the leader may 1. Restart a cluster. - You can use `kbcli` or create an OpsRequest to restart a cluster. + You can use `kbcli` or create an OpsRequest to restart a cluster. **Option 1.** (**Recommended**) Use kbcli diff --git a/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md b/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md index e6e6a418d00..fce294ce86b 100644 --- a/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md +++ b/docs/user_docs/kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md @@ -14,7 +14,7 @@ KubeBlocks supports Pulsar's daily operations, including basic lifecycle operati ## Environment Recommendation -Refer to the Pulsar official document for the configuration, such as memory, cpu, and storage, of each component. +Refer to the [Pulsar official document](https://pulsar.apache.org/docs/3.1.x/) for the configuration, such as memory, cpu, and storage, of each component. | Components | Replicas | | :-------------------- | :------------------------------------------------------------------------ | @@ -88,7 +88,7 @@ Refer to the Pulsar official document for the configuration, such as memory, cpu ``` - **Option 2**: Create pulsar cluster with proxy. - Configuration: + Configuration: - proxy: 3 replicas - broker: 3 replicas - bookies: 4 replicas diff --git a/docs/user_docs/kubeblocks-for-vector-database/manage-vector-databases.md b/docs/user_docs/kubeblocks-for-vector-database/manage-vector-databases.md index 2ebe404302a..2e5e690245b 100644 --- a/docs/user_docs/kubeblocks-for-vector-database/manage-vector-databases.md +++ b/docs/user_docs/kubeblocks-for-vector-database/manage-vector-databases.md @@ -8,6 +8,7 @@ sidebar_label: Manage Vector Databases with KubeBlocks # Manage Vector Databases with KubeBlocks The popularity of generative AI (Generative AI) has aroused widespread attention and completely ignited the vector database (Vector Database) market. KubeBlocks supports the management of vector databases, such as Qdrant, Milvus, and Weaviate. + In this chapter, we take Qdrant as an example to show how to manage vector databases with KubeBlocks. Before you start, [install KubeBlocks](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) and `kbcli`.