[Feat]: Archive Document Version 1.2 (apache#1854)

### Summary 1. Removed document version 1.2. 2. Add htaccess configuration file to direct to the correct 404 page. 3. Implemented several scripts to facilitate the generation of correctly formatted PDFs - translateTitle:Generate a Chinese and English mapping through the i18n file to translate the English in the directory - filterSidebarTree:Recursively remove one or more categories under the premise that the default label is unique* - removeDuplicateTitle:Remove duplicate titles - trimCodeFunc:Remove spaces before code blocks - adjustTips:Tip Block Conversion 5. Added Chinese and English pages for archived documents. ![image](https://github.com/user-attachments/assets/8c5c7e35-0ca4-4769-ac09-8b3c70e73f80) ![image](https://github.com/user-attachments/assets/3ab56b6c-4c1f-4e33-b581-df5fc7677b77)
xiaozhuoyang · Jan 23, 2025 · 51c4dba · 51c4dba
1 parent 0d4c61b
commit 51c4dba
Show file tree

Hide file tree

Showing 558 changed files with 2,740 additions and 2,188 deletions.
diff --git a/.github/workflows/manual-deploy-website.yml b/.github/workflows/manual-deploy-website.yml
@@ -46,6 +46,7 @@ jobs:
                   cp .asf-site.yaml ./build/.asf.yaml
                   cp versions.json ./build/
                   cp worker.js ./build/
+                  cp .htaccess ./build/
                   ls build
                   export DORIS_COMMIT=`git rev-parse HEAD`
 

diff --git a/.htaccess b/.htaccess
@@ -0,0 +1 @@
+ErrorDocument 404 /404.html
diff --git a/docs/releasenotes/v1.1/release-1.1.0.md b/docs/releasenotes/v1.1/release-1.1.0.md
@@ -88,11 +88,11 @@ On all 13 SQLs in the SSB test data set, version 1.1 is better than version 0.15
 
 On all 22 SQLs in the TPC-H test data set, version 1.1 is better than version 0.15, the overall performance is improved by about 4.5 times, and the performance of some scenarios is improved by more than ten times;
 
-![](/images/release-note-1.1.0-SSB.png)
+![release-note-1.1.0-SSB](/images/release-note-1.1.0-SSB.png)
 
 <p align='center'>SSB Benchmark</p>
 
-![](/images/release-note-1.1.0-TPC-H.png)
+![release-note-1.1.0-TPC-H](/images/release-note-1.1.0-TPC-H.png)
 
 
 <p align='center'>TPC-H Benchmark</p>

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -320,6 +320,12 @@ const config = {
                     {
                         type: 'docsVersionDropdown',
                         position: 'right',
+                        dropdownItemsAfter: [
+                            {
+                                label: '归档文档',
+                                to: `/zh-CN/archive-docs`,
+                            },
+                        ],
                     },
                 ],
             },
@@ -342,6 +348,12 @@ const config = {
                     {
                         type: 'docsVersionDropdown',
                         position: 'right',
+                        dropdownItemsAfter: [
+                            {
+                                label: 'Archived Docs',
+                                to: `/archive-docs`,
+                            },
+                        ],
                     },
                 ],
             },

diff --git a/i18n/zh-CN/code.json b/i18n/zh-CN/code.json
@@ -0,0 +1,46 @@
+{
+    "archive.page.title": {
+        "message": "归档文档中心",
+        "description": "The label for archived docs page title"
+    },
+    "archive.admonition.1": {
+        "message": "此为 Apache Doris 归档文档，已归档文档不再提供任何更新。",
+        "description": "The label for admonition in archived docs page"
+    },
+    "archive.admonition.2": {
+        "message": "建议使用",
+        "description": "The label for admonition in archived docs page"
+    },
+    "archive.page.2": {
+        "message": "建议使用 {stableLink}或{latestLink}。",
+        "description": "The label for admonition in archived docs page"
+    },
+    "archive.admonition.stable": {
+        "message": "版本（2.1）",
+        "description": "stable version"
+    },
+    "archive.admonition.latest": {
+        "message": "版本（3.0）",
+        "description": "latest version"
+    },
+    "archive.admonition.and": {
+        "message": "或",
+        "description": "and"
+    },
+    "archive.page.version": {
+        "message": "版本：1.2",
+        "description": "Archive Download Version"
+    },
+    "archive.download.v12": {
+        "message": "归档文档链接：{downloadLink}",
+        "description": "Archive download link"
+    },
+    "archive.download.link": {
+        "message": "Apache Doris v1.2 中文文档",
+        "description": "Archive download link"
+    },
+    "archive.download.date": {
+        "message": "归档日期：{date}",
+        "description": "Archive date"
+    }
+}
diff --git a/...zh-CN/docusaurus-plugin-content-docs/current/releasenotes/v1.1/release-1.1.0.md b/...zh-CN/docusaurus-plugin-content-docs/current/releasenotes/v1.1/release-1.1.0.md
@@ -89,11 +89,11 @@ Iceberg 外部表为 Apache Doris 提供了直接访问存储在 Iceberg 数据
 
 -   在 TPC-H 测试数据集的全部 22 个 SQL 上，1.1 版本均优于 0.15 版本，整体性能约提升了 4.5 倍，部分场景性能达到了十余倍的提升；
 
-![](/images/release-note-1.1.0-SSB.png)
+![release-note-1.1.0-SSB](/images/release-note-1.1.0-SSB.png)
 
 <p align='center'>SSB 测试数据集</p>
 
-![](/images/release-note-1.1.0-TPC-H.png)
+![release-note-1.1.0-TPC-H](/images/release-note-1.1.0-TPC-H.png)
 
 <p align='center'>TPC-H 测试数据集</p>
 

diff --git a/...n-content-docs/version-1.2/admin-manual/cluster-management/elastic-expansion.md b/...n-content-docs/version-1.2/admin-manual/cluster-management/elastic-expansion.md
@@ -131,8 +131,8 @@ DECOMMISSION 语句如下：
 > 3. 该命令**不一定执行成功**。比如剩余 BE 存储空间不足以容纳下线 BE 上的数据，或者剩余机器数量不满足最小副本数时，该命令都无法完成，并且 BE 会一直处于 `SystemDecommissioned` 为 true 的状态。
 > 4. DECOMMISSION 的进度，可以通过 ```SHOW PROC '/backends';``` 中的 TabletNum 查看，如果正在进行，TabletNum 将不断减少。
 > 5. 该操作可以通过:  
-     > 		```CANCEL DECOMMISSION BACKEND "be_host:be_heartbeat_service_port";```  
-     > 	命令取消。取消后，该 BE 上的数据将维持当前剩余的数据量。后续 Doris 重新进行负载均衡
+> 		```CANCEL DECOMMISSION BACKEND "be_host:be_heartbeat_service_port";```  
+> 	命令取消。取消后，该 BE 上的数据将维持当前剩余的数据量。后续 Doris 重新进行负载均衡
 
 **对于多租户部署环境下，BE 节点的扩容和缩容，请参阅 [多租户设计文档](../multi-tenant.md)。**
 

diff --git a/...CN/docusaurus-plugin-content-docs/version-1.2/admin-manual/data-admin/backup.md b/...CN/docusaurus-plugin-content-docs/version-1.2/admin-manual/data-admin/backup.md
@@ -48,17 +48,17 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
 
    如果该表是动态分区表，备份之后会自动禁用动态分区属性，在做恢复的时候需要手动将该表的动态分区属性启用，命令如下：
 
-   ```sql
+```sql
    ALTER TABLE tbl1 SET ("dynamic_partition.enable"="true")
-   ```
+```
 
 4. 备份和恢复操作都不会保留表的 `colocate_with` 属性。
 
 ## 开始备份
 
 1. 创建一个 hdfs 的远程仓库 example_repo：
 
-   ```sql
+```sql
    CREATE REPOSITORY `example_repo`
    WITH BROKER `hdfs_broker`
    ON LOCATION "hdfs://hadoop-name-node:54310/path/to/repo/"
@@ -67,11 +67,11 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
       "username" = "user",
       "password" = "password"
    );
-   ```
+```
 
 2. 创建一个 s3 的远程仓库 : s3_repo
 
-   ```
+```
    CREATE REPOSITORY `s3_repo`
    WITH S3
    ON LOCATION "s3://bucket_name/test"
@@ -82,36 +82,36 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
        "AWS_SECRET_KEY"="xxx",
        "AWS_REGION" = "xxx"
    ); 
-   ```
+```
 
    >注意：
    >
    >ON LOCATION 这里后面跟的是 Bucket Name
 
 2. 全量备份 example_db 下的表 example_tbl 到仓库 example_repo 中：
 
-   ```sql
+```sql
    BACKUP SNAPSHOT example_db.snapshot_label1
    TO example_repo
    ON (example_tbl)
    PROPERTIES ("type" = "full");
-   ```
+```
 
 3. 全量备份 example_db 下，表 example_tbl 的 p1, p2 分区，以及表 example_tbl2 到仓库 example_repo 中：
 
-   ```sql
+```sql
    BACKUP SNAPSHOT example_db.snapshot_label2
    TO example_repo
    ON
    (
       example_tbl PARTITION (p1,p2),
       example_tbl2
    );
-   ```
+```
 
 4. 查看最近 backup 作业的执行情况：
 
-   ```sql
+```sql
    mysql> show BACKUP\G;
    *************************** 1. row ***************************
                   JobId: 17891847
@@ -129,19 +129,19 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
                  Status: [OK]
                 Timeout: 86400
    1 row in set (0.01 sec)
-   ```
+```
 
 5. 查看远端仓库中已存在的备份
 
-   ```sql
+```sql
    mysql> SHOW SNAPSHOT ON example_repo WHERE SNAPSHOT = "snapshot_label1";
    +-----------------+---------------------+--------+
    | Snapshot        | Timestamp           | Status |
    +-----------------+---------------------+--------+
    | snapshot_label1 | 2022-04-08-15-52-29 | OK     |
    +-----------------+---------------------+--------+
    1 row in set (0.15 sec)
-   ```
+```
 
 BACKUP 的更多用法可参考 [这里](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/BACKUP.md)。
 

diff --git a/...N/docusaurus-plugin-content-docs/version-1.2/admin-manual/data-admin/restore.md b/...N/docusaurus-plugin-content-docs/version-1.2/admin-manual/data-admin/restore.md
@@ -56,7 +56,7 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
 
 1. 从 example_repo 中恢复备份 snapshot_1 中的表 backup_tbl 到数据库 example_db1，时间版本为 "2018-05-04-16-45-08"。恢复为 1 个副本：
 
-    ```sql
+```sql
     RESTORE SNAPSHOT example_db1.`snapshot_1`
     FROM `example_repo`
     ON ( `backup_tbl` )
@@ -65,11 +65,11 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
         "backup_timestamp"="2022-04-08-15-52-29",
         "replication_num" = "1"
     );
-    ```
+```
 
 2. 从 example_repo 中恢复备份 snapshot_2 中的表 backup_tbl 的分区 p1,p2，以及表 backup_tbl2 到数据库 example_db1，并重命名为 new_tbl，时间版本为 "2018-05-04-17-11-01"。默认恢复为 3 个副本：
 
-    ```sql
+```sql
     RESTORE SNAPSHOT example_db1.`snapshot_2`
     FROM `example_repo`
     ON
@@ -81,11 +81,11 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
     (
         "backup_timestamp"="2022-04-08-15-55-43"
     );
-    ```
+```
 
 3. 查看 restore 作业的执行情况:
 
-   ```sql
+```sql
    mysql> SHOW RESTORE\G;
    *************************** 1. row ***************************
                   JobId: 17891851
@@ -124,7 +124,7 @@ Doris 支持将当前数据以文件的形式，通过 broker 备份到远端存
                  Status: [OK]
                 Timeout: 86400
    1 row in set (0.01 sec)
-   ```
+```
 
 RESTORE的更多用法可参考 [这里](../../sql-manual/sql-reference/Data-Definition-Statements/Backup-and-Restore/RESTORE.md)。
 

diff --git a/...ugin-content-docs/version-1.2/admin-manual/http-actions/be/compaction-action.md b/...ugin-content-docs/version-1.2/admin-manual/http-actions/be/compaction-action.md
@@ -155,6 +155,7 @@ curl -X POST http://be_host:webserver_port/api/compaction/run?tablet_id=xxxx\&co
 
 * status：触发任务状态，当成功触发时为Success；当因某些原因（比如，没有获取到合适的版本）时，返回Fail。
 * msg：给出具体的成功或失败的信息。
+
 ### 示例
 
 ```
@@ -210,3 +211,5 @@ curl -X GET http://be_host:webserver_port/api/compaction/run_status?tablet_id=xx
 
 ```
 curl -X GET http://192.168.10.24:8040/api/compaction/run_status?tablet_id=10015
+
+```
diff --git a/...dmin-manual/http-actions/be/pad_rowset.md → ...dmin-manual/http-actions/be/pad-rowset.md b/...dmin-manual/http-actions/be/pad_rowset.md → ...dmin-manual/http-actions/be/pad-rowset.md
diff --git a/...l/http-actions/be/tablets_distribution.md → ...l/http-actions/be/tablets-distribution.md b/...l/http-actions/be/tablets_distribution.md → ...l/http-actions/be/tablets-distribution.md
diff --git a/...-plugin-content-docs/version-1.2/admin-manual/http-actions/fe/get-small-file.md b/...-plugin-content-docs/version-1.2/admin-manual/http-actions/fe/get-small-file.md
@@ -33,6 +33,7 @@ under the License.
 ## Description
 
 通过文件id，下载在文件管理器中的文件。    
+
 ## Path parameters
 
 无

diff --git a/...ontent-docs/version-1.2/admin-manual/http-actions/fe/table-query-plan-action.md b/...ontent-docs/version-1.2/admin-manual/http-actions/fe/table-query-plan-action.md
@@ -73,7 +73,25 @@ under the License.
 				"schemaHash": 1294206575
 			}
 		},
-		"opaqued_query_plan": "DAABDAACDwABDAAAAAEIAAEAAAAACAACAAAAAAgAAwAAAAAKAAT//////////w8ABQgAAAABAAAAAA8ABgIAAAABAAIACAAMABIIAAEAAAAADwACCwAAAAIAAAACazEAAAACazIPAAMIAAAAAgAAAAUAAAAFAgAEAQAAAA8ABAwAAAACDwABDAAAAAEIAAEAAAAQDAACDwABDAAAAAEIAAEAAAAADAACCAABAAAABQAAAAgABAAAAAAMAA8IAAEAAAAACAACAAAAAAAIABT/////CAAX/////wAADwABDAAAAAEIAAEAAAAQDAACDwABDAAAAAEIAAEAAAAADAACCAABAAAABQAAAAgABAAAAAAMAA8IAAEAAAABCAACAAAAAAAIABT/////CAAX/////wAADAAFCAABAAAABgwACAAADAAGCAABAAAAAA8AAgwAAAAAAAoABwAAAAAAAAAACgAIAAAAAAAAAAAADQACCgwAAAABAAAAAAAAJzcKAAEAAAAAAAAnNwoAAgAAAAAAAAACCgADDaJlqbrVdwgIAARNJAZvAAwAAw8AAQwAAAACCAABAAAAAAgAAgAAAAAMAAMPAAEMAAAAAQgAAQAAAAAMAAIIAAEAAAAFAAAACAAE/////wgABQAAAAQIAAYAAAAACAAHAAAAAAsACAAAAAJrMQgACQAAAAACAAoBAAgAAQAAAAEIAAIAAAAADAADDwABDAAAAAEIAAEAAAAADAACCAABAAAABQAAAAgABP////8IAAUAAAAICAAGAAAAAAgABwAAAAELAAgAAAACazIIAAkAAAABAgAKAQAPAAIMAAAAAQgAAQAAAAAIAAIAAAAMCAADAAAAAQoABAAAAAAAACc1CAAFAAAAAgAPAAMMAAAAAQoAAQAAAAAAACc1CAACAAAAAQgAAwAAAAIIAAQAAAAACwAHAAAABHRibDELAAgAAAAADAALCwABAAAABHRibDEAAAAMAAQKAAFfL5rpxl1I4goAArgs6f+h6eMxAAA=",
+		"opaqued_query_plan": "DAABDAACDwABDAAAAAEIAAEAAAAACAACAAAAAAgAAwAAAAAKAAT//////////
+		w8ABQgAAAABAAAAAA8ABgIAAAABAAIACAAMABIIAAEAAAAADwACCwAAAAIAAAACazEAAAACazIPAAMIAAAAA
+		gAAAAUAAAAFAgAEAQAAAA8ABAwAAAACDwABDAAAAAEIAAEAAAAQDAACDwABDAAAAAEIAAEAAAAADAACCAABA
+		AAABQAAAAgABAAAAAAMAA8IAAEAAAAACAACAAAAAAAIABT
+		/////CAAX/////
+		wAADwABDAAAAAEIAAEAAAAQDAACDwABDAAAAAEIAAEAAAAADAACCAABAAAABQAAAAgABAAAAAAMAA8IAAEAA
+		AABCAACAAAAAAAIABT
+		/////CAAX/////
+		wAADAAFCAABAAAABgwACAAADAAGCAABAAAAAA8AAgwAAAAAAAoABwAAAAAAAAAACgAIAAAAAAAAAAAADQACC
+		gwAAAABAAAAAAAAJzcKAAEAAAAAAAAnNwoAAgAAAAAAAAACCgADDaJlqbrVdwgIAARNJAZvAAwAAw8AAQwAA
+		AACCAABAAAAAAgAAgAAAAAMAAMPAAEMAAAAAQgAAQAAAAAMAAIIAAEAAAAFAAAACAAE
+		/////
+		wgABQAAAAQIAAYAAAAACAAHAAAAAAsACAAAAAJrMQgACQAAAAACAAoBAAgAAQAAAAEIAAIAAAAADAADDwABD
+		AAAAAEIAAEAAAAADAACCAABAAAABQAAAAgABP
+		////
+		8IAAUAAAAICAAGAAAAAAgABwAAAAELAAgAAAACazIIAAkAAAABAgAKAQAPAAIMAAAAAQgAAQAAAAAIAAIAAA
+		AMCAADAAAAAQoABAAAAAAAACc1CAAFAAAAAgAPAAMMAAAAAQoAAQAAAAAAACc1CAACAAAAAQgAAwAAAAIIAA
+		QAAAAACwAHAAAABHRibDELAAgAAAAADAALCwABAAAABHRibDEAAAAMAAQKAAFfL5rpxl1I4goAArgs6f+h6e
+		MxAAA=",
 		"status": 200
 	},
 	"count": 0

diff --git a/...lugin-content-docs/version-1.2/admin-manual/maint-monitor/metadata-operation.md b/...lugin-content-docs/version-1.2/admin-manual/maint-monitor/metadata-operation.md
@@ -305,6 +305,7 @@ FE 的元数据日志以 Key-Value 的方式存储在 BDBJE 中。某些异常
 
 ```
 mysql> show proc "/bdbje";
+
 +----------+---------------+---------+
 | DbNames  | JournalNumber | Comment |
 +----------+---------------+---------+
@@ -318,6 +319,7 @@ mysql> show proc "/bdbje";
 
 ```
 mysql> show proc "/bdbje/110589";
+
 +-----------+
 | JournalId |
 +-----------+
@@ -337,6 +339,7 @@ mysql> show proc "/bdbje/110589";
 
 ```
 mysql> show proc "/bdbje/110589/114861";
+
 +-----------+--------------+---------------------------------------------+
 | JournalId | OpType       | Data                                        |
 +-----------+--------------+---------------------------------------------+
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,6 +33,7 @@ under the License. @@
     ## Description
     通过文件id，下载在文件管理器中的文件。
     ## Path parameters
     无
@@ Expand Down @@