update doc

moooofly · Jun 13, 2018 · ad89b5f · ad89b5f
1 parent 41c7394
commit ad89b5f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/docs/Harbor 镜像删除问题.md b/docs/Harbor 镜像删除问题.md
@@ -18,17 +18,17 @@
 > Run the below commands on the host which Harbor is deployed on to **preview** what files/images will be affected:
 >
 > ```
-$ docker-compose stop
-$ docker run -it --name gc --rm --volumes-from registry vmware/registry:2.6.2-photon garbage-collect --dry-run /etc/registry/config.yml
+> $ docker-compose stop
+> $ docker run -it --name gc --rm --volumes-from registry vmware/registry:2.6.2-photon garbage-collect --dry-run /etc/registry/config.yml
 > ```
 >
 > NOTE: The above option "--dry-run" will print the progress without removing any data.
 >
 > Verify the result of the above test, then use the below commands to **perform garbage collection** and restart Harbor.
 >
 > ```
-$ docker run -it --name gc --rm --volumes-from registry vmware/registry:2.6.2-photon garbage-collect  /etc/registry/config.yml
-$ docker-compose start
+> $ docker run -it --name gc --rm --volumes-from registry vmware/registry:2.6.2-photon garbage-collect  /etc/registry/config.yml
+> $ docker-compose start
 > ```
 >
 > For more information about GC, please see GC.

diff --git a/docs/Retention Policy 设计.md b/docs/Retention Policy 设计.md
@@ -1,3 +1,7 @@
+# WARNING
+
+> **Notice:** This document is **deprecated**, this here is kept for historical purpose.
+
 # Retention Policy 设计
 
 ## 前提
@@ -40,7 +44,7 @@
 
 ### 分析
 
-- 理论上将，在 harbor 中针对 `projects`/`repositories`/`tags`/`images` 这些对象都可以进行清理操作（其中 images 的处理和其他有所不同）；
+- 理论上讲，在 harbor 中针对 `projects`/`repositories`/`tags`/`images` 这些对象都可以进行清理操作（其中 images 的处理和其他有所不同）；
 - 当前设计主要针对 **repositories** 级别进行清理操作；
 - harbor-go-client 的实现基于 harbor v1.2.0 版本进行；