Skip to content

Commit

Permalink
Merge pull request #13 from yg3630536/feature/optimize-doc
Browse files Browse the repository at this point in the history
* Optimize doc
  • Loading branch information
yanggang-JV committed Apr 26, 2020
2 parents 709a7f7 + f3d7289 commit 4cf3afa
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 10 deletions.
18 changes: 13 additions & 5 deletions readthedocs/zh_CN/docs/how-to-run-unit-test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,23 @@ LINUX 系统上通过 gradle 执行单元测试
cp fisco.properties weidentity.properties ../../src/test/resources/
3, 将生成好的 ``ca.crt`` 和 ``client.keystore`` 复制到
``src/test/resources`` 目录, 这两个证书是 WeIdentity 运行所需要的 SDK
证书。
3, 将证书文件复制到 ``src/test/resources`` 目录,证书是 WeIdentity 运行所需要的 SDK 证书。

* 如果您使用的是 FISCO BCOS2.X 版本,请将您的 ``ca.crt``、``node.crt`` 和 ``node.key`` 复制到 ``src/test/resources`` 目录。

.. code:: shell
cp ca.crt node.crt node.key ../../src/test/resources/
4, 将字体 ``NotoSansCJKtc-Regular.ttf`` 复制到 ``src/test/resources`` 目录,并进行字体安装。

.. code:: shell
cp ca.crt client.keystore ../../src/test/resources/
cp ../lib/NotoSansCJKtc-Regular.ttf ../../src/test/resources/
注:字体安装请参照 \ `技术问题列表 <./faq.html>`__\ 中的字体安装说明。

4, 回到项目根目录,执行测试命令。
5, 回到项目根目录,执行测试命令。

.. code:: shell
Expand Down
9 changes: 8 additions & 1 deletion readthedocs/zh_CN/docs/weidentity-installation-by-web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,14 @@ WeIdentity JAVA SDK安装部署文档(可视化版本)
source ./install_build_tool.sh
3.启动Web服务
3.执行构建脚本
""""""""""

.. code-block:: shell
source ./build.sh
4.启动Web服务
""""""""""

.. code-block:: shell
Expand Down
6 changes: 3 additions & 3 deletions readthedocs/zh_CN/docs/weidentity-installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ WeIdentity Java SDK 安装部署
* - 操作系统
- 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>`_\ \ `「FISCO-BCOS 1.3节点安装方法」 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-1.3/docs/tools/index.html>`_\ 来搭建一套区块链环境。
- 您需要有一套可以运行的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>`_\
* - gradle
Expand All @@ -37,8 +37,8 @@ WeIdentity Java SDK 安装部署

我们提供两种方式安装部署SDK(包括两步:首先将WeIdentity智能合约部署到区块链上,再集成SDK到您的Java工程中):

* `安装部署工具方式 - 可视化版本<./weidentity-installation-by-web.html>`_ (推荐方式)
* `安装部署工具方式 - 命令版本<./weidentity-build-with-deploy.html>`_
* `安装部署工具方式 - 可视化版本 <./weidentity-installation-by-web.html>`_ (推荐方式)
* `安装部署工具方式 - 命令版本 <./weidentity-build-with-deploy.html>`_
* `源码方式 <./weidentity-installation-by-sourcecode.html>`_

.. note::
Expand Down
5 changes: 4 additions & 1 deletion readthedocs/zh_CN/docs/weidentity-quick-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,5 +182,8 @@ WeIdentity JAVA SDK 便捷使用工具
Begin to generate presentation policy ...
Presentation policy template is successfully generated, you can find it at /home/app/tonychen/test_gradle/weid-build-tools/output/presentation_policy.

表明生成的 CPT 的 POJO 的jar包在 ``/home/app/tonychen/test_gradle/weid-build-tools/output/pojo/0x8ce1fc7af86917b503d7d5aaa2987a33ccf97f767199a360712fee667a54ef80/d8acebb597d0428fac682ad188e4312d/`` 目录下,
表明生成的 CPT 的 POJO 的jar包在 ``/home/app/tonychen/test_gradle/weid-build-tools/output/pojo/xxx/`` 目录下,
生成的 presentation policy 模板在 ``/home/app/tonychen/test_gradle/weid-build-tools/output/presentation_policy`` 。

.. note::
xxx为您启用的CNS地址

0 comments on commit 4cf3afa

Please sign in to comment.