From 0d3fe8f07b6068ec8a82c3703a177d60a1aa4c75 Mon Sep 17 00:00:00 2001
From: steadyBoy <35027788+steadyBoy@users.noreply.github.com>
Date: Thu, 27 Jan 2022 10:34:34 +0800
Subject: [PATCH] [typo](docs) fix document backup-restore.md typo (#7868)

Refactor the document format and improve the content of the English version
---
 docs/en/administrator-guide/backup-restore.md |  5 ++-
 .../administrator-guide/backup-restore.md     | 38 +++++++++----------
 2 files changed, 22 insertions(+), 21 deletions(-)

diff --git a/docs/en/administrator-guide/backup-restore.md b/docs/en/administrator-guide/backup-restore.md
index c19da829b4..b7ae9ca82d 100644
--- a/docs/en/administrator-guide/backup-restore.md
+++ b/docs/en/administrator-guide/backup-restore.md
@@ -5,7 +5,7 @@
 }
 ---
 
-<!-- 
+<!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
@@ -94,7 +94,8 @@ The commands related to the backup recovery function are as follows. The followi
 
 1. CREATE REPOSITORY
 
-	Create a remote warehouse Path for backup or recovery.
+	Create a remote warehouse Path for backup or recovery. This command needs to access the remote storage through the Broker. Different brokers need to provide different parameters. For details, please refer to [Broker Document] (broker.md), or directly back up to the remote storage supporting AWS S3 protocol through S3 protocol. For details, please refer to [CREATE REPOSITORY DOCUMENT] (../sql-reference/sql-statements/Data%20Definition/CREATE%20REPOSITORY.md)
+
 
 1. BACKUP
 
diff --git a/docs/zh-CN/administrator-guide/backup-restore.md b/docs/zh-CN/administrator-guide/backup-restore.md
index f3e094f25d..3d1d631f09 100644
--- a/docs/zh-CN/administrator-guide/backup-restore.md
+++ b/docs/zh-CN/administrator-guide/backup-restore.md
@@ -5,7 +5,7 @@
 }
 ---
 
-<!-- 
+<!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
@@ -41,11 +41,11 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
 1. 快照及快照上传
 
     快照阶段会对指定的表或分区数据文件进行快照。之后，备份都是对快照进行操作。在快照之后，对表进行的更改、导入等操作都不再影响备份的结果。快照只是对当前数据文件产生一个硬链，耗时很少。快照完成后，会开始对这些快照文件进行逐一上传。快照上传由各个 Backend 并发完成。
-    
+
 2. 元数据准备及上传
 
     数据文件快照上传完成后，Frontend 会首先将对应元数据写成本地文件，然后通过 broker 将本地元数据文件上传到远端仓库。完成最终备份作业。
-    
+
 ### 恢复（Restore）
 
 恢复操作需要指定一个远端仓库中已存在的备份，然后将这个备份的内容恢复到本地集群中。当用户提交 Restore 请求后，系统内部会做如下操作：
@@ -53,19 +53,19 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
 1. 在本地创建对应的元数据
 
     这一步首先会在本地集群中，创建恢复对应的表分区等结构。创建完成后，该表可见，但是不可访问。
-    
+
 2. 本地snapshot
 
     这一步是将上一步创建的表做一个快照。这其实是一个空快照（因为刚创建的表是没有数据的），其目的主要是在 Backend 上产生对应的快照目录，用于之后接收从远端仓库下载的快照文件。
-    
+
 3. 下载快照
 
     远端仓库中的快照文件，会被下载到对应的上一步生成的快照目录中。这一步由各个 Backend 并发完成。
-    
+
 4. 生效快照
 
     快照下载完成后，我们要将各个快照映射为当前本地表的元数据。然后重新加载这些快照，使之生效，完成最终的恢复作业。
-    
+
 ## 最佳实践
 
 ### 备份
@@ -77,14 +77,14 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
 用户可以先将数据备份到远端仓库，再通过远端仓库将数据恢复到另一个集群，完成数据迁移。因为数据备份是通过快照的形式完成的，所以，在备份作业的快照阶段之后的新的导入数据，是不会备份的。因此，在快照完成后，到恢复作业完成这期间，在原集群上导入的数据，都需要在新集群上同样导入一遍。
 
 建议在迁移完成后，对新旧两个集群并行导入一段时间。完成数据和业务正确性校验后，再将业务迁移到新的集群。
-    
+
 ## 重点说明
 
 1. 备份恢复相关的操作目前只允许拥有 ADMIN 权限的用户执行。
 2. 一个 Database 内，只允许有一个正在执行的备份或恢复作业。
 3. 备份和恢复都支持最小分区（Partition）级别的操作，当表的数据量很大时，建议按分区分别执行，以降低失败重试的代价。
 4. 因为备份恢复操作，操作的都是实际的数据文件。所以当一个表的分片过多，或者一个分片有过多的小版本时，可能即使总数据量很小，依然需要备份或恢复很长时间。用户可以通过 `SHOW PARTITIONS FROM table_name;` 和 `SHOW TABLET FROM table_name;` 来查看各个分区的分片数量，以及各个分片的文件版本数量，来预估作业执行时间。文件数量对作业执行的时间影响非常大，所以建议在建表时，合理规划分区分桶，以避免过多的分片。
-5. 当通过 `SHOW BACKUP` 或者 `SHOW RESTORE` 命令查看作业状态时。有可能会在 `TaskErrMsg` 一列中看到错误信息。但只要 `State` 列不为 
+5. 当通过 `SHOW BACKUP` 或者 `SHOW RESTORE` 命令查看作业状态时。有可能会在 `TaskErrMsg` 一列中看到错误信息。但只要 `State` 列不为
  `CANCELLED`，则说明作业依然在继续。这些 Task 有可能会重试成功。当然，有些 Task 错误，也会直接导致作业失败。
 6. 如果恢复作业是一次覆盖操作（指定恢复数据到已经存在的表或分区中），那么从恢复作业的 `COMMIT` 阶段开始，当前集群上被覆盖的数据有可能不能再被还原。此时如果恢复作业失败或被取消，有可能造成之前的数据已损坏且无法访问。这种情况下，只能通过再次执行恢复操作，并等待作业完成。因此，我们建议，如无必要，尽量不要使用覆盖的方式恢复数据，除非确认当前数据已不再使用。
 
@@ -94,16 +94,16 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
 
 1. CREATE REPOSITORY
 
-    创建一个远端仓库路径，用于备份或恢复。该命令需要借助 Broker 进程访问远端存储，不同的 Broker 需要提供不同的参数，具体请参阅 [Broker文档](broker.md)，也可以直接通过S3 协议备份到支持AWS S3协议的远程存储上去，具体参考 [创建远程仓库文档](../sql-reference/sql-statements/Data Definition/CREATE REPOSITORY.md)
+    创建一个远端仓库路径，用于备份或恢复。该命令需要借助 Broker 进程访问远端存储，不同的 Broker 需要提供不同的参数，具体请参阅 [Broker文档](broker.md)，也可以直接通过S3 协议备份到支持AWS S3协议的远程存储上去，具体参考 [创建远程仓库文档](../sql-reference/sql-statements/Data%20Definition/CREATE%20REPOSITORY.md)
 
 1. BACKUP
 
     执行一次备份操作。
-    
+
 3. SHOW BACKUP
 
     查看最近一次 backup 作业的执行情况，包括：
-    
+
     * JobId：本次备份作业的 id。
     * SnapshotName：用户指定的本次备份作业的名称（Label）。
     * DbName：备份作业对应的 Database。
@@ -129,24 +129,24 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
 4. SHOW SNAPSHOT
 
     查看远端仓库中已存在的备份。
-    
+
     * Snapshot：备份时指定的该备份的名称（Label）。
     * Timestamp：备份的时间戳。
     * Status：该备份是否正常。
 
     如果在 `SHOW SNAPSHOT` 后指定了 where 子句，则可以显示更详细的备份信息。
-    
+
     * Database：备份时对应的 Database。
     * Details：展示了该备份完整的数据目录结构。
 
 5. RESTORE
 
     执行一次恢复操作。
-    
+
 6. SHOW RESTORE
 
     查看最近一次 restore 作业的执行情况，包括：
-    
+
     * JobId：本次恢复作业的 id。
     * Label：用户指定的仓库中备份的名称（Label）。
     * Timestamp：用户指定的仓库中备份的时间戳。
@@ -172,15 +172,15 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
     * TaskErrMsg：如果有子任务执行出错，这里会显示对应子任务的错误信息。
     * Status：用于记录在整个作业过程中，可能出现的一些状态信息。
     * Timeout：作业的超时时间，单位是秒。
-    
+
 7. CANCEL BACKUP
 
     取消当前正在执行的备份作业。
-    
+
 8. CANCEL RESTORE
 
     取消当前正在执行的恢复作业。
-    
+
 9. DROP REPOSITORY
 
     删除已创建的远端仓库。删除仓库，仅仅是删除该仓库在 Doris 中的映射，不会删除实际的仓库数据。
\ No newline at end of file