Merge pull request #45 from WeBankFinTech/feature/one-stop

Add one stop page and fix doc descriptions
WeBankBlockchain · Aug 1, 2019 · 7f1de1a · 7f1de1a
2 parents d0c275d + a2b1ddf
commit 7f1de1a
Show file tree

Hide file tree

Showing 8 changed files with 92 additions and 60 deletions.
diff --git a/README-en.rst b/README-en.rst
@@ -83,7 +83,7 @@ More
 *
    `FAQ <https://weidentity.readthedocs.io/en/latest/docs/faq.html>`_
 
-Getting Started
+Current Status
 ---------------
 
 WeIdentity is running on top of FISCO-BCOS with JAVA SDK provided for developers, please review the Installation & Deployment guide and SDK user guide listed below:
@@ -104,6 +104,7 @@ WeIdentity is running on top of FISCO-BCOS with JAVA SDK provided for developers
                <ul>
                  <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-installation.html">Installation and Deployment Guide (Chinese Version)</a></li>
                  <li><a href="https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/docs/weidentity-java-sdk-doc.html">SDK User Guide (Chinese Version)</a></li>
+                 <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-rest.html">RestService Guide (Chinese Version)</a></li>
                </ul>
             </td>
             <td>

diff --git a/README.rst b/README.rst
@@ -80,27 +80,28 @@ WeIdentity支持认证机构自行注册标准化凭证模板，共同丰富公
    `WeIdentity规范文档 <https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-spec.html>`_
 
 
-开始使用
+当前状态
 --------
 
-WeIdentity目前支持基于FISCO-BCOS运行，并提供JAVA SDK供调用。具体的规范文档、安装部署和SDK使用指引请参考如下文档：
+WeIdentity目前支持基于FISCO-BCOS的区块链，并提供Java SDK及RestService方式供部署。具体的规范文档、安装部署和使用指引如下表所示：
 
 
 .. raw:: html
 
     <embed>
-      <table style="border-collapse:collapse">
+      <table border='1' style="border-collapse:collapse" class='tables'>
          <tr>
             <th width="20%">集成方法</th>
             <th width="30%">文档入口</th>
             <th width="50%">当前状态</th>
          </tr>
          <tr>
-            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weid-java-sdk">JAVA SDK</a></td>
+            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weid-java-sdk">Java SDK</a></td>
             <td>
                <ul>
                  <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-installation.html">安装部署文档</a></li>
                  <li><a href="https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/docs/weidentity-java-sdk-doc.html">SDK使用文档</a></li>
+                 <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-rest.html">RestService集成文档</a></li>
                </ul>
             </td>
             <td>

diff --git a/docs/en/README.rst b/docs/en/README.rst
@@ -82,7 +82,7 @@ More
    `FAQ <https://weidentity.readthedocs.io/en/latest/docs/faq.html>`_
 
 
-Getting Started
+Current Status
 ---------------
 
 WeIdentity is running on top of FISCO-BCOS with JAVA SDK provided for developers, please review the Installation & Deployment guide and SDK user guide listed below:
@@ -103,6 +103,7 @@ WeIdentity is running on top of FISCO-BCOS with JAVA SDK provided for developers
                <ul>
                  <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-installation.html">Installation and Deployment Guide (Chinese Version)</a></li>
                  <li><a href="https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/docs/weidentity-java-sdk-doc.html">SDK User Guide (Chinese Version)</a></li>
+                 <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-rest.html">RestService Guide (Chinese Version)</a></li>
                </ul>
             </td>
             <td>

diff --git a/docs/zh_CN/README.rst b/docs/zh_CN/README.rst
@@ -67,20 +67,11 @@ WeIdentity DID秉承以下设计理念：
 
 WeIdentity支持认证机构自行注册标准化凭证模板，共同丰富公众联盟链的生态。
 
-更多
-^^^^
 
-*
-   `案例及场景 <https://weidentity.readthedocs.io/zh_CN/latest/docs/use-cases.html>`_
-
-*
-   `WeIdentity规范文档 <https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-spec.html>`_
-
-
-开始使用
+当前状态
 --------
 
-WeIdentity目前支持基于FISCO-BCOS运行，并提供JAVA SDK供调用。具体的规范文档、安装部署和SDK使用指引请参考如下文档：
+WeIdentity目前支持基于FISCO-BCOS的区块链，并提供Java SDK及RestService方式供部署。具体的规范文档、安装部署和使用指引如下表所示：
 
 
 .. raw:: html
@@ -93,11 +84,12 @@ WeIdentity目前支持基于FISCO-BCOS运行，并提供JAVA SDK供调用。具
             <th width="50%">当前状态</th>
          </tr>
          <tr>
-            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weid-java-sdk">JAVA SDK</a></td>
+            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weid-java-sdk">Java SDK</a></td>
             <td>
                <ul>
                  <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-installation.html">安装部署文档</a></li>
                  <li><a href="https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/docs/weidentity-java-sdk-doc.html">SDK使用文档</a></li>
+                 <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-rest.html">RestService集成文档</a></li>
                </ul>
             </td>
             <td>
@@ -114,6 +106,11 @@ WeIdentity目前支持基于FISCO-BCOS运行，并提供JAVA SDK供调用。具
       <br />
     </embed>
 
+感受WeIdentity
+----------------
+
+接下来，您可以在\ `此页 <docs/one-stop-experience.html>`_ 一站式了解WeIdentity的参考场景，体验Demo流程，并了解完整的部署方式及参考实现。
+
 联系我们
 --------
 

diff --git a/docs/zh_CN/docs/one-stop-experience.rst b/docs/zh_CN/docs/one-stop-experience.rst
@@ -0,0 +1,63 @@
+
+.. _one-stop-experience:
+
+WeIdentity 一站式体验
+======================
+
+本页化繁为简地聊了聊WeIdentity，您可以在此快速了解WeIdentity的参考场景、体验Demo、快速部署并体验WeIdentity的核心功能。
+如果您是开发人员，还可以进一步了解WeIdentity的参考实现，以及深入了解SDK的使用方式。
+
+WeIdentity参考场景
+-------------------
+
+.. image:: images/roles-relation.png
+   :alt: roles-relation.png
+
+在WeIdentity生态中，存在着上图所示的几类角色，不同角色的权责和角色之间的关系如下表所示：
+
+.. list-table::
+   :header-rows: 1
+
+   * - 角色
+     - 说明
+   * - User (Entity)
+     - 用户（实体）。会在链上注册属于自己的WeIdentity DID，从Issuer处申请Credential，并授权转发或直接出示给Verifier来使用之。
+   * - Issuer
+     - Credential的发行者。会验证实体对WeIdentity DID的所有权，其次发行实体相关的Credential。
+   * - Verifier
+     - Credential的使用者。会验证实体对WeIdentity DID的所有权，其次在链上验证Credential的真实性，以便处理相关业务。
+   * - User Agent / Credential Repository
+     - 用户（实体）在此生成WeIdentity DID。为了便于使用，实体也可将自己的私钥、持有的Credential托管于此。
+
+在实际业务里，WeIdentity可以被广泛运用在「实体身份标识」及「可信数据交换」场景中。首先，User Agent会为不同的实体生成独立唯一互不相同的DID；其次，Issuer在验证了实体身份及DID所有权后，会为实体发行各种各样的电子化Credential。实体可以将这些Credential存在实体私有本地存储，也可以托管给某个凭证存储机构；当实体需要去Verifier办理某种业务的时候，实体可以直接将Credential出示给Verifier，也可以通过在链上进行主动授权的方式由凭证存储机构转发给Verifier。以上流程保证了数据以实体用户为中心，同时实体身份、确权、授权等操作在链上完成，可以追溯，不可篡改。
+
+Demo体验
+---------- 
+
+下面提供了几个不同场景的WeIdentity Demo：
+
+.. list-table::
+   :header-rows: 1
+
+   * - 使用场景
+     - 访问入口
+     - 设计说明
+   * - 学历信息电子化
+     - \ `开始体验 <https://sandbox.webank.com/weid>`_\
+     - 基于WeID，将用户身份同电子身份ID对应的学历信息电子化，Hash上链，保证身份和学历信息高效验证，不可篡改
+   * - 游戏积分上链
+     - \ `游戏页面 <https://sandbox.webank.com/weidgame/>`_\
+
+       \ `计分板 <https://sandbox.webank.com/weidgame/scoreboard.html>`_\
+     - 基于WeID，用户游戏积分需要授权才会发到区块链上进行统计，可以看到详细的链上授权记录，不可篡改
+
+快速部署与上手
+----------------
+
+您可以参照 \ `部署文档 <./weidentiy-installation.html>`_\，进行WeIdentity的快速部署与上手。
+
+WeIdentity参考实现
+-------------------
+
+深入了解：SDK文档
+------------------
diff --git a/docs/zh_CN/docs/weidentity-installation.rst b/docs/zh_CN/docs/weidentity-installation.rst
@@ -3,8 +3,8 @@
 
 .. _weidentity-installation:
 
-WeIdentity JAVA SDK安装部署文档
-===============================
+WeIdentity Java SDK 安装部署文档
+================================
 
 
 整体介绍