update doc

LinuxSuRen · Nov 15, 2021 · 0d58b0d · 0d58b0d
1 parent 9207d4a
commit 0d58b0d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/...oy/cluster-deploy/doc/fate_on_eggroll/Fate-allinone_deployment_guide_install.md b/...oy/cluster-deploy/doc/fate_on_eggroll/Fate-allinone_deployment_guide_install.md
@@ -252,14 +252,14 @@ Note: In this guide, the installation directory is /data/projects/ and the execu
 
 Go to the /data/projects/ directory of the execution node and execute:
 
+Note: Replace ${version} with specific FATE version number,can be viewed on the [release page](https://github.com/FederatedAI/FATE/releases).
+
 ```
 cd /data/projects/
-wget https://webank-ai-1251170195.cos.ap-guangzhou.myqcloud.com/fate_cluster_install_{version}_release-c7-u18.tar.gz
-tar xzf fate_cluster_install_{version}_release-c7-u18.tar.gz
+wget https://webank-ai-1251170195.cos.ap-guangzhou.myqcloud.com/fate_cluster_install_${version}_release-c7-u18.tar.gz
+tar xzf fate_cluster_install_${version}_release-c7-u18.tar.gz
 ```
 
-Note: {version}can be viewed on the [release page](https://github.com/FederatedAI/FATE/releases).
-
 ## 5.2 Pre-Deployment Check
 
 **Execute as app user on the destination server (192.168.0.1, 192.168.0.2)**

diff --git a/...cluster-deploy/doc/fate_on_eggroll/Fate-allinone_deployment_guide_install_zh.md b/...cluster-deploy/doc/fate_on_eggroll/Fate-allinone_deployment_guide_install_zh.md
@@ -263,14 +263,14 @@ Swap:        131071           0      131071
 
 进入执行节点的/data/projects/目录，执行：
 
+备注：用具体FATE版本号替换${version},可在[release页面](https://github.com/FederatedAI/FATE/releases)上查看
+
 ```
 cd /data/projects/
-wget https://webank-ai-1251170195.cos.ap-guangzhou.myqcloud.com/fate_cluster_install_{version}_release-c7-u18.tar.gz
-tar xzf fate_cluster_install_{version}_release-c7-u18.tar.gz
+wget https://webank-ai-1251170195.cos.ap-guangzhou.myqcloud.com/fate_cluster_install_${version}_release-c7-u18.tar.gz
+tar xzf fate_cluster_install_${version}_release-c7-u18.tar.gz
 ```
 
-注：{version}可在[release页面](https://github.com/FederatedAI/FATE/releases)上查看 
-
 ## 5.2 部署前检查
 
 **在目标服务器（192.168.0.1 192.168.0.2 ）app用户下执行**
@@ -305,7 +305,7 @@ vi fate-cluster-install/allInone/conf/setup.conf
 | 配置项              | 配置项值                                              | 说明                                                         |
 | ------------------- | ----------------------------------------------------- | ------------------------------------------------------------ |
 | roles               | 默认："host" "guest"                                  | 部署的角色，有HOST端、GUEST端                                |
-| version             | 默认：{version}                                       | Fate 版本号                                                  |
+| version             | 默认：${version}                                      | Fate 版本号                                                  |
 | pbase               | 默认： /data/projects                                 | 项目根目录                                                   |
 | lbase               | 默认：/data/logs                                      | 保持默认不要修改                                             |
 | ssh_user            | 默认：app                                             | ssh连接目标机器的用户，也是部署后文件的属主                  |
@@ -340,7 +340,7 @@ vi fate-cluster-install/allInone/conf/setup.conf
 #to install role
 roles=( "host" "guest" )
 
-version="{version}"
+version="${version}"
 #project base
 pbase="/data/projects"
 #log directory
@@ -405,7 +405,7 @@ nodemanager_port=4671
 #to install role
 roles=( "host" )
 
-version="{version}"
+version="${version}"
 #project base
 pbase="/data/projects"
 #log directory

diff --git a/deploy/cluster-deploy/doc/fate_on_eggroll/Fate-exchange_deployment_guide.md b/deploy/cluster-deploy/doc/fate_on_eggroll/Fate-exchange_deployment_guide.md
@@ -25,9 +25,9 @@ The architecture diagram:
 
 # 3\. Component Description
 
-| Software| Component| Port| Description
-|----------|----------|----------|----------
-| eggroll| rollsite| 9370| The cross-site/party communication component, equivalent to proxy+federation; each party can only have one for this service
+| Software | Component | Port | Description                                                  |
+| -------- | --------- | ---- | ------------------------------------------------------------ |
+| eggroll  | rollsite  | 9370 | The cross-site/party communication component, equivalent to proxy+federation; each party can only have one for this service |
 
 # 4\. Basic Environment Configuration
 
@@ -133,6 +133,8 @@ Note: In this guide, the installation directory is /data/projects/install and th
 
 Execute as app user on the destination server (192.168.0.1 with extranet environment):
 
+Note: Replace ${version} with the specific FATE version number.
+
 ```
 cd /data/projects/install
 wget https://webank-ai-1251170195.cos.ap-guangzhou.myqcloud.com/jdk-8u192-linux-x64.tar.gz