* update document

readthedocs/zh_CN/docs/faq.md

@@ -268,8 +268,8 @@ Credential的重新生成则为重新发行一个Credential ID不相同的全新
 
 Evidence的key是数据的hash值（通过WeIdentity SDK提供的sha3函数计算得出）。
 
-| 字段	| 类型| 说明| 
-| ----- | ----- | ----- | 
+| 字段	| 类型| 说明|
+| ----- | ----- | ----- |
 | hash|  bytes32[] | 存证数据的 hash，同时也是key |
 | signer| address[]| 签名人的地址（WeAddress）
 | sigs|  string[] | 对应每个签名人的签名值 |
@@ -316,4 +316,3 @@ Evidence的key是数据的hash值（通过WeIdentity SDK提供的sha3函数计
 如果MYSQL有设置最大链接数，请注意将连接数设置为：业务系统连接池maxActive + SDK的maxActive。否则有可能出现数据库锁表的情况。
 
 ---
-

readthedocs/zh_CN/docs/how-to-contribute.rst

@@ -0,0 +1,50 @@
+.. role:: raw-html-m2r(raw)
+   :format: html
+
+.. _how-to-contribute:
+
+如何贡献
+================================
+
+
+规范和流程
+------------------------
+
+开始贡献之前，建议阅读我们的代码规范文档和代码提交步骤介绍。
+
+* `如何贡献提前必看 <https://github.com/WeBankFinTech/WeIdentity/blob/master/.github/CONTRIBUTING.md>`_
+
+
+
+为\ `WeIdentity Java SDK <https://github.com/WeBankFinTech/WeIdentity>`_\ 贡献代码
+-----------------------------------------------------------------------------------------
+
+
+* 代码贡献者按这种方式搭建 WeIdentity Java SDK 环境: `“下载源码的方式进行安装” <./weidentity-installation-by-sourcecode.html>`_
+
+
+* \ `如何运行单元测试 <./how-to-run-unit-test.html>`_\
+
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   weidentity-build-with-deploy.rst
+   weidentity-installation-by-sourcecode.rst
+
+
+
+
+
+便捷工具
+----------
+
+当您部署SDK完成之后，可以通过一些便捷工具快速上手体验SDK，请参考 \ `WeIdentity 便捷工具使用 <./weidentity-quick-tools.html>`__\。
+
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   weidentity-quick-tools.rst

readthedocs/zh_CN/docs/one-stop-experience.rst

@@ -4,11 +4,28 @@
 WeIdentity 入门
 ======================
 
+准备工作
+--------
+
+.. list-table::
+   :header-rows: 1
+
+   * - 配置
+     - 说明
+   * - 操作系统
+     - CentOS （7.2.* 64位）或Ubuntu（16.04 64位）。
+   * - FISCO-BCOS区块链环境
+     - 您需要有一套可以运行的FISCO-BCOS区块链环境，如果没有，可以参考\ `「FISCO-BCOS 2.0节点安装方法」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/installation.html>`_\ 来搭建一套区块链环境。
+   * - JDK
+     - 要求\ `JDK1.8+ <https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html>`_\ ，推荐使用jdk8u141。JDK 跟 WeID 直接的兼容性，可见\ `兼容性文档 <https://weidentity.readthedocs.io/zh_CN/latest/docs/weid-compatibility-test.html>`_\
+   * - 网络连通
+     - 检查部署 WeIdentity JAVA SDK 的服务器是否能 telnet 通 FISCO BCOS 节点的 channel 端口（\ `channel端口是什么，详见 <https://mp.weixin.qq.com/s/XZ0pXEELaj8kXHo32UFprg>`_\），若telnet不通，需要检查网络连通性和安全策略。
+
 
 第1步：安装 WeIdentity 部署工具
 ------------------------------
 
-您可以参照\ `安装 WeIdentity 部署工具 <./weidentity-installation.html?highlight=推荐方式>`_\，安装 WeIdentity 部署工具。
+您可以参照\ `“安装 WeIdentity 部署工具” <./weidentity-installation-by-web.html>`_\，安装 WeIdentity 部署工具。
 
 第2步：使用 WeIdentity 部署工具完成部署
 ---------------------------------------

readthedocs/zh_CN/docs/sdk-integration.rst

@@ -23,7 +23,7 @@
     compile("com.webank:weid-java-sdk:x.x.x")
 
 .. note::
-   x.x.x为您使用的weid-java-sdk版本号，建议指定使用版本号，避免自动引入最新版本导致前后不兼容。 版本号可以查看 \ `版本历史 <https://mvnrepository.com/artifact/com.webank/weid-java-sdk>`__  
+   x.x.x为您使用的weid-java-sdk版本号，建议指定使用版本号，避免自动引入最新版本导致前后不兼容。 版本号可以查看 \ `版本历史 <https://mvnrepository.com/artifact/com.webank/weid-java-sdk>`__
 
 
 
@@ -42,4 +42,5 @@
 现在您可以使用 WeIdentity 开发您的区块链身份应用。WeIdentity Java SDK 相关接口请见：\ `WeIdentity JAVA SDK文档 <./projects/javasdk/weidentity-java-sdk-doc.html>`__ 。
 
 
-
+.. note::
+     注意：如果您使用了针对oracle jdk1.8.0.231及以上版本，不论用哪种方式部署SDK，在使用时都需要配置jvm参数 -Djdk.tls.namedGroups="secp256k1" 。详细原因，请见Oracle JDK 8u231的Release Notes： https://www.oracle.com/technetwork/java/javase/8u231-relnotes-5592812.html

readthedocs/zh_CN/docs/weidentity-installation-by-sourcecode.rst

@@ -6,6 +6,10 @@
 WeIdentity JAVA SDK安装部署文档（源码方式）
 =================================================
 
+.. note::
+     注意：如果您使用了针对oracle jdk1.8.0.231及以上版本，不论用哪种方式部署SDK，在使用时都需要配置jvm参数 -Djdk.tls.namedGroups="secp256k1" 。详细原因，请见Oracle JDK 8u231的Release Notes： https://www.oracle.com/technetwork/java/javase/8u231-relnotes-5592812.html
+
+
 1.下载源码
 """"""""""
 
@@ -14,7 +18,7 @@ WeIdentity JAVA SDK安装部署文档（源码方式）
 
 
 * 下载最新的代码
-  
+
 .. code-block:: shell
 
   git clone https://github.com/WeBankFinTech/WeIdentity.git
@@ -51,7 +55,7 @@ WeIdentity Java SDK 工程见\ `WeIdentity JAVA SDK <https://github.com/WeBankFi
  | ``mysql_database`` ：配置数据库名称
  | ``mysql_username`` ：配置数据库用户名
  | ``mysql_password`` ：配置数据库用户对应的密码
- 
+
 
 配置样例：
 ::
@@ -63,20 +67,20 @@ WeIdentity Java SDK 工程见\ `WeIdentity JAVA SDK <https://github.com/WeBankFi
     org_id=organizationA
 
     #链标识
-    chain_id=1 
-    
+    chain_id=1
+
     #数据库ip和port
     mysql_address=0.0.0.0:3306
-    
+
     #数据库名称
     mysql_database=database
-    
+
     #数据库用户名
     mysql_username=username
-    
+
     #数据库密码
     mysql_password=password
- 
+
 .. 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或更高版本。
 

readthedocs/zh_CN/index.rst

@@ -32,3 +32,4 @@ WeIdentity文档
    docs/weidentity-rest.rst
    docs/weidentity-endpoint.rst
    docs/weidentity-contract-design.rst
+   docs/how-to-contribute.rst