Doc for V2 (#166)

* fix ocp-express example * update V2.0.0 docs
oceanbase · Apr 24, 2023 · db864e1 · db864e1
1 parent 885d969
commit db864e1
Show file tree

Hide file tree

Showing 26 changed files with 3,837 additions and 157 deletions.
diff --git a/docs/en-US/3.user-guide/1.quickly-start-the-oceanbase-database.md b/docs/en-US/3.user-guide/1.quickly-start-the-oceanbase-database.md
@@ -10,6 +10,8 @@ After you deploy OceanBase Deployer (OBD), you can run the `obd demo` command to
 
 - At least 54 GB of disk space is available on the server.
 
+- Your server can be connected to the network, or there are installation packages required for deployment.
+
 > **Note**
 >
 > If the foregoing prerequisites are not met, see [Use OBD to start an OceanBase cluster](../3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md).

diff --git a/docs/en-US/3.user-guide/3.obd-command/0.obd-demo.md b/docs/en-US/3.user-guide/3.obd-command/0.obd-demo.md
@@ -36,6 +36,8 @@ obd demo -c oceanbase-ce,obproxy-ce --obproxy-ce.home_path=/data/demo/
 obd demo --oceanbase-ce.mysql_port=3881
 ```
 
+For more information about the relevant configuration items in the configuration file, refer to [Configuration file description](../../4.configuration-file-description.md).
+
 > **Notice**
 >
 > This command supports only level-1 configurations under global that are specified by using options.
diff --git a/docs/en-US/3.user-guide/3.obd-command/1.cluster-command-groups.md b/docs/en-US/3.user-guide/3.obd-command/1.cluster-command-groups.md
diff --git a/...-US/3.user-guide/3.obd-command/2.command-group-for-mirroring-and-warehousing.md b/...-US/3.user-guide/3.obd-command/2.command-group-for-mirroring-and-warehousing.md
@@ -1,8 +1,8 @@
 # Mirror and repository commands
 
-OBD provides multiple-level commands. You can use the`-h/--help` option to view the help information of sub-commands.
+OBD provides multiple-level commands. You can use the `-h/--help` option to view the help information of sub-commands. Similarly, you can also use `-v/--verbose` to view the detailed execution process of commands when the execution of sub commands reports an error.
 
-## `obd mirror clone`
+## obd mirror clone
 
 Copy an RPM package to the local mirror repository. You can run the corresponding OBD cluster command to start the mirror.
 
@@ -14,27 +14,27 @@ obd mirror clone <path> [-f]
 
 The `-f` option is `--force`. `-f` is optional. This option is disabled by default. If it is enabled and a mirror of the same name exists in the repository, the copied mirror will forcibly overwrite the existing one.
 
-## `obd mirror create`
+## obd mirror create
 
 Creates a mirror based on the local directory. When OBD starts a user-compiled open-source OceanBase software, you can run this command to add the compilation output to the local repository. Then, you can run the corresponding `obd cluster` command to start the mirror.
 
 ```shell
 obd mirror create -n <component name> -p <your compile dir> -V <component version> [-t <tag>] [-f]
 ```
 
-For example, you can [compile an OceanBase cluster based on the source code](https://www.oceanbase.com/en/docs/community-observer-en-10000000000209369). Then, you can run the `make DESTDIR=./ install && obd mirror create -n oceanbase-ce -V 3.1.0 -p ./usr/local` command to add the compilation output to the local repository of OBD.
+For example, you can [compile an OceanBase cluster based on the source code](https://en.oceanbase.com/docs/community-observer-en-10000000000209369). Then, you can run the `make DESTDIR=./ install && obd mirror create -n oceanbase-ce -V 3.1.0 -p ./usr/local` command to add the compilation output to the local repository of OBD.
 
 This table describes the corresponding options.
 
 | Option | Required | Data type | Description |
---- | --- | --- |---
-| -n/--name | Yes | string | The component name. If you want to compile an OceanBase cluster, set this option to oceanbase-ce. If you want to compile ODP, set this option to obproxy.  |
+|----|-----|-----|----|
+| -n/--name | Yes | string | The component name. If you want to compile an OceanBase cluster, set this option to oceanbase-ce. If you want to compile ODP, set this option to obproxy-ce.  |
 | -p/--path | Yes | string | The directory that stores the compilation output. OBD will automatically retrieve files required by the component from this directory.  |
 | -V/--version | Yes | string | The component version.  |
 | -t/--tag | No | string | The mirror tags. You can define one or more tags for the created mirror. Separate multiple tags with commas (,).  |
 | -f/--force | No | bool | Specifies whether to forcibly overwrite an existing mirror or tag. This option is disabled by default.  |
 
-## `obd mirror list`
+## obd mirror list
 
 Shows the mirror repository or mirror list.
 
@@ -44,15 +44,15 @@ obd mirror list [mirror repo name]
 
 `mirror repo name` specifies the mirror repository name. This parameter is optional. When it is not specified, all mirror repositories will be returned. When it is specified, only the specified mirror repository will be returned.
 
-## `obd mirror update`
+## obd mirror update
 
 Synchronizes the information of all remote mirror repositories.
 
 ```shell
 obd mirror update
 ```
 
-## `obd mirror disable`
+## obd mirror disable
 
 Disable remote mirror repositories. To disable all the remote mirror repositories, run the `obd mirror disable remote` command.
 
@@ -62,7 +62,7 @@ obd mirror disable <mirror_repo_name>
 
 Parameter `mirror repo name` specifies the mirror repository name. When you specify `remote`, all the remote mirror repositories are disabled.
 
-## `obd mirror enable`
+## obd mirror enable
 
 Enable remote mirror repositories.