Add Multi-Group deployment and fix invalid chars

Signed-off-by: chaoxinhu <chaoxinhu@hotmail.com>
WeBankBlockchain · Dec 6, 2019 · 54f956b · 54f956b
1 parent 5c79125
commit 54f956b
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 8 deletions.
diff --git a/docs/zh_CN/docs/faq.md b/docs/zh_CN/docs/faq.md
@@ -2,10 +2,9 @@
 
 ---
 
-技术问题 FAQ 列表：  
+技术问题列表：  
 
 * [JAVA SDK FAQ](./faq-java.html)
-* [WeIdentity 网络端口](./weidentity-ports.html)
 
 ---
 

diff --git a/docs/zh_CN/docs/how-to-deploy-w-groupid.md b/docs/zh_CN/docs/how-to-deploy-w-groupid.md
@@ -0,0 +1,30 @@
+# 在FISCO-BCOS上跨群组部署WeIdentity
+
+WeIdentity支持FISCO-BCOS 2.x的跨群组功能。您可以在确定被访问的节点存在多个群组的前提下，通过指定群组ID，达到跨群组部署、执行WeIdentity功能的目的。具体场景和步骤如下。
+
+注意：您必须首先确认被连接的节点确实处于需要连接的群组里。否则，WeIdentity会报错，错误为“群组不存在”。
+
+## 安装部署工具跨群组部署WeIdentity
+
+您只需在下载部署工具之后，修改位于`\script\tpl`中的`fisco.properties.tpl`，找到其中的：
+
+```
+group.id=1
+```
+
+并将其中的1修改为您想要连接的群组，之后，正常运行`compile.sh`及`deploy.sh`以完成编译和部署。
+
+## 源码方式跨群组部署WeIdentity
+
+您只需在下载源码之后，修改位于源代码目录下`\src\main\resource`中的`fisco.properties.tpl`，找到其中的：
+
+```
+group.id=1
+```
+
+并将其中的1修改为您想要连接的群组，之后，正常运行`run.sh`以完成编译和部署。
+
+## 切换群组
+
+在FISCO-BCOS的多群组架构中，不同群组之间的链上智能合约和WeID是完全无法互通的。在不同的群组上部署的WeIdentity智能合约会被存入当前的`fisco.properties`中。
+如果您在多个群组上都部署了WeIdentity合约，那么建议您在切换群组之前，备份本群组特定的`fisco.properties`。未来，只需替换此配置文件，就可以达到切换群组的目的。
diff --git a/docs/zh_CN/docs/miscellaneous.md b/docs/zh_CN/docs/miscellaneous.md
@@ -6,8 +6,10 @@
 
 * [如何进行单元测试](./how-to-run-unit-test.html)
 
-* [如何离线部署WeIdentity](./how-to-run-without-internet.html)
+* [离线部署WeIdentity](./how-to-run-without-internet.html)
 
-* [安全建议](./security-suggestion.html)
+* [跨群组部署WeIdentity](./how-to-deploy-w-groupid.html)
 
+* [安全建议](./security-suggestion.html)
 
+* [WeIdentity 网络端口](./weidentity-ports.html)
diff --git a/docs/zh_CN/docs/security-suggestion.md b/docs/zh_CN/docs/security-suggestion.md
@@ -36,13 +36,14 @@
 * SDK 被嵌入执行的父应用判断，避免恶意应用嵌入
 * SDK 升级能力，保存在 APP 里面的证书需要定时更新
 * Android 接入腾讯乐固加固和腾讯金刚扫描（发现四大组件权限设置问题，如调用方权限；防止仿编译等。）
-参考：[腾讯乐固](http://wiki.open.qq.com/wiki/%E5%BA%94%E7%94%A8%E5%8A%A0%E5%9B%BA)
+参考：[腾讯乐固](http://wiki.open.qq.com/wiki/%E5%BA%94%E7%94%A8%E5%8A%A0%E5%9B%BA)
 * Android 监测到 root 设备提示用户不安全问用户是否继续执行
 * Android APP 防止二次打包（对比签名）
 * iOS 反调试代码，监测是否越狱
 
 ## 5.其它
 * 安全编码规范：OWASP 安全编码规范:
 
- [(English Version) OWASP_SCP_Quick_Reference_Guide](https://www.owasp.org/index.php/File:OWASP_SCP_Quick_Reference_Guide_v2.pdf) ;
+ [(English Version) OWASP_SCP_Quick_Reference_Guide](https://www.owasp.org/index.php/File:OWASP_SCP_Quick_Reference_Guide_v2.pdf) 
+
 [(中文) OWASP_SCP_Quick_Reference_Guide](https://www.owasp.org/index.php/File:OWASP_SCP_Quick_Reference_Guide_\(Chinese\).pdf)
diff --git a/docs/zh_CN/docs/weidentity-build-with-deploy.rst b/docs/zh_CN/docs/weidentity-build-with-deploy.rst
@@ -84,6 +84,9 @@ weid-java-sdk 可以同时支持 FISCO BCOS 1.3 版本和 FISCO BCOS 2.0 版本
 
 保存退出，即完成基本配置。
 
+.. note::
+     如果您使用FISCO-BCOS 2.x，且需要跨群组部署WeIdentity，请参考\ `跨群组部署WeIdentity <./how-to-deploy-w-groupid.html>`__\ 。
+
 
 1.2.2 配置节点证书和秘钥文件
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

diff --git a/docs/zh_CN/docs/weidentity-installation-by-sourcecode.rst b/docs/zh_CN/docs/weidentity-installation-by-sourcecode.rst
@@ -68,6 +68,8 @@ WeIdentity JAVA SDK安装部署文档（源码方式）
 .. note::
      注意：如果您使用了Gradle 6.0+，那么您需要手动修改build.gradle中spotbug的Gradle插件版本号为2.0.0+。具体地，打开WeIdentity/build.gradle，将“classpath "gradle.plugin.com.github.spotbugs:spotbugs-gradle-plugin:1.6.5"”中的1.6.5改成2.0.0或更高版本。
 
+.. note::
+     如果您使用FISCO-BCOS 2.x，且需要跨群组部署WeIdentity，请参考\ `跨群组部署WeIdentity <./how-to-deploy-w-groupid.html>`__\ 。
 
 2.安装部署
 """"""""""

diff --git a/docs/zh_CN/docs/weidentity-installation.rst b/docs/zh_CN/docs/weidentity-installation.rst
@@ -43,4 +43,4 @@ WeIdentity Java SDK 安装部署
 便捷工具
 ----------
 
-我们提供了一些快捷工具，可以帮您快速上手体验 weid-java-sdk，请参考 \ `WeIdentity JAVA SDK 便捷工具使用 <./weidentity-quick-tools.html>`__\。
+当您部署SDK完成之后，可以通过一些便捷工具快速上手体验SDK，请参考 \ `WeIdentity JAVA SDK 便捷工具使用 <./weidentity-quick-tools.html>`__\。
diff --git a/docs/zh_CN/index.rst b/docs/zh_CN/index.rst
@@ -25,8 +25,8 @@ WeIdentity文档
    docs/weidentity-contract-design.rst
    docs/faq.md
    docs/miscellaneous.md
-   docs/weidentity-rest.rst
    docs/weidentity-installation.rst
+   docs/weidentity-rest.rst
    docs/weidentity-sample.rst
    docs/weidentity-endpoint.rst
    WeIdentity Java SDK 文档 <https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/>