Merge pull request #29 from WeBankFinTech/develop

modify badge url
WeBankBlockchain · Jun 24, 2019 · 00d80f8 · 00d80f8
2 parents ef3ee7b + 3da4a32
commit 00d80f8
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 37 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -24,7 +24,7 @@
 
 #### 分支管理
 
-代码类工程我们使用 [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) 进行分支管理。包括这些工程： [weidentity-java-sdk](https://github.com/WeBankFinTech/weidentity-java-sdk)， [weidentity-contract](https://github.com/WeBankFinTech/weidentity-contract)。  
+代码类工程我们使用 [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) 进行分支管理。包括这些工程： [weid-java-sdk](https://github.com/WeBankFinTech/weid-java-sdk)， [weid-contract](https://github.com/WeBankFinTech/weid-contract)。
 文档类工程我们使用 [github-flow](http://scottchacon.com/2011/08/31/github-flow.html) 进行分支管理。包括这些工程： [WeIdentity](https://github.com/WeBankFinTech/WeIdentity)。
 
 #### 代码规范
@@ -40,7 +40,7 @@
 使用英文简要描述修改点，每一行描述一个修改点，并以 `*` 开头，如下所示：
 
 ```text
-first release for weidentity-contract
+first release for weid-contract
 
 * Smart Contract for DID identity management, allowing external
 addresses which satisfy FISCO-BCOS specifications to be used as the
@@ -55,7 +55,7 @@ data & logic contracts.
 
 ### 3.2 流程
 
-1. Fork 希望提交代码修改的 repository 。例如，如果想要修改 [weidentity-java-sdk](https://github.com/WeBankFinTech/weidentity-java-sdk) ，则 Fork 这个 repository。
+1. Fork 希望提交代码修改的 repository 。例如，如果想要修改 [weid-java-sdk](https://github.com/WeBankFinTech/weid-java-sdk) ，则 Fork 这个 repository。
 
 2. 创建新的分支，例如分支取名为 `feature/add-verfiy-logic` （分支名请使用 `feature/` 开头）。
 

diff --git a/README-en.rst b/README-en.rst
@@ -99,20 +99,20 @@ WeIdentity is running on top of FISCO-BCOS with JAVA SDK provided for developers
             <th width="40%">Status</th>
          </tr>
          <tr>
-            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weidentity-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/projects/javasdk/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>
                </ul>
             </td>
             <td>
-               <a href="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk.svg?branch=master" /></a>
-               <a href="https://github.com/WeBankFinTech/weidentity-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weidentity-java-sdk.svg" /></a>
+               <a href="https://travis-ci.org/WeBankFinTech/weid-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weid-java-sdk.svg?branch=master" /></a>
+               <a href="https://github.com/WeBankFinTech/weid-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weid-java-sdk.svg" /></a>
                <a href="https://search.maven.org/search?q=g:%22com.webank%22%20AND%20a:%22weidentity-java-sdk%22"><img src="https://img.shields.io/maven-central/v/com.webank/weidentity-java-sdk.svg?label=Maven%20Central" /></a>
-               <a href="https://app.codacy.com/app/webankadmin/weidentity-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weidentity-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
-               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk/badge" /></a>
-               <a href="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk/branch/master/graph/badge.svg" /></a>
+               <a href="https://app.codacy.com/app/webankadmin/weid-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weid-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
+               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk/badge" /></a>
+               <a href="https://codecov.io/gh/WeBankFinTech/weid-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weid-java-sdk/branch/master/graph/badge.svg" /></a>
                <a href="https://www.gnu.org/licenses/lgpl-3.0"><img src="https://img.shields.io/badge/license-GNU%20LGPL%20v3.0-blue.svg" /></a>
             </td>
          </tr>

diff --git a/README.rst b/README.rst
@@ -96,20 +96,20 @@ WeIdentity目前支持基于FISCO-BCOS运行，并提供JAVA SDK供调用。具
             <th width="50%">当前状态</th>
          </tr>
          <tr>
-            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weidentity-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/projects/javasdk/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>
                </ul>
             </td>
             <td>
-               <a href="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk.svg?branch=master" /></a>
-               <a href="https://github.com/WeBankFinTech/weidentity-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weidentity-java-sdk.svg" /></a>
+               <a href="https://travis-ci.org/WeBankFinTech/weid-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weid-java-sdk.svg?branch=master" /></a>
+               <a href="https://github.com/WeBankFinTech/weid-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weid-java-sdk.svg" /></a>
                <a href="https://search.maven.org/search?q=g:%22com.webank%22%20AND%20a:%22weidentity-java-sdk%22"><img src="https://img.shields.io/maven-central/v/com.webank/weidentity-java-sdk.svg?label=Maven%20Central" /></a>
-               <a href="https://app.codacy.com/app/webankadmin/weidentity-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weidentity-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
-               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk/badge" /></a>
-               <a href="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk/branch/master/graph/badge.svg" /></a>
+               <a href="https://app.codacy.com/app/webankadmin/weid-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weid-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
+               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk/badge" /></a>
+               <a href="https://codecov.io/gh/WeBankFinTech/weid-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weid-java-sdk/branch/master/graph/badge.svg" /></a>
                <a href="https://www.gnu.org/licenses/lgpl-3.0"><img src="https://img.shields.io/badge/license-GNU%20LGPL%20v3.0-blue.svg" /></a>
             </td>
          </tr>

diff --git a/docs/en/README.rst b/docs/en/README.rst
@@ -98,20 +98,20 @@ WeIdentity is running on top of FISCO-BCOS with JAVA SDK provided for developers
             <th width="40%">Status</th>
          </tr>
          <tr>
-            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weidentity-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/projects/javasdk/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>
                </ul>
             </td>
             <td>
-               <a href="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk.svg?branch=master" /></a>
-               <a href="https://github.com/WeBankFinTech/weidentity-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weidentity-java-sdk.svg" /></a>
+               <a href="https://travis-ci.org/WeBankFinTech/weid-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weid-java-sdk.svg?branch=master" /></a>
+               <a href="https://github.com/WeBankFinTech/weid-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weid-java-sdk.svg" /></a>
                <a href="https://search.maven.org/search?q=g:%22com.webank%22%20AND%20a:%22weidentity-java-sdk%22"><img src="https://img.shields.io/maven-central/v/com.webank/weidentity-java-sdk.svg?label=Maven%20Central" /></a>
-               <a href="https://app.codacy.com/app/webankadmin/weidentity-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weidentity-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
-               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk/badge" /></a>
-               <a href="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk/branch/master/graph/badge.svg" /></a>
+               <a href="https://app.codacy.com/app/webankadmin/weid-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weid-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
+               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk/badge" /></a>
+               <a href="https://codecov.io/gh/WeBankFinTech/weid-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weid-java-sdk/branch/master/graph/badge.svg" /></a>
                <a href="https://www.gnu.org/licenses/lgpl-3.0"><img src="https://img.shields.io/badge/license-GNU%20LGPL%20v3.0-blue.svg" /></a>
             </td>
          </tr>

diff --git a/docs/en/conf.py b/docs/en/conf.py
@@ -275,7 +275,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'weidentity', 'WeIdentity Documentation',
+    (master_doc, 'WeIdentity', 'WeIdentity Documentation',
      [author], 1)
 ]
 

diff --git a/docs/zh_CN/README.rst b/docs/zh_CN/README.rst
@@ -93,20 +93,20 @@ WeIdentity目前支持基于FISCO-BCOS运行，并提供JAVA SDK供调用。具
             <th width="50%">当前状态</th>
          </tr>
          <tr>
-            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/weidentity-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/projects/javasdk/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>
                </ul>
             </td>
             <td>
-               <a href="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weidentity-java-sdk.svg?branch=master" /></a>
-               <a href="https://github.com/WeBankFinTech/weidentity-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weidentity-java-sdk.svg" /></a>
+               <a href="https://travis-ci.org/WeBankFinTech/weid-java-sdk"><img src="https://travis-ci.org/WeBankFinTech/weid-java-sdk.svg?branch=master" /></a>
+               <a href="https://github.com/WeBankFinTech/weid-java-sdk/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/weid-java-sdk.svg" /></a>
                <a href="https://search.maven.org/search?q=g:%22com.webank%22%20AND%20a:%22weidentity-java-sdk%22"><img src="https://img.shields.io/maven-central/v/com.webank/weidentity-java-sdk.svg?label=Maven%20Central" /></a>
-               <a href="https://app.codacy.com/app/webankadmin/weidentity-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weidentity-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
-               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weidentity-java-sdk/badge" /></a>
-               <a href="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weidentity-java-sdk/branch/master/graph/badge.svg" /></a>
+               <a href="https://app.codacy.com/app/webankadmin/weid-java-sdk?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/weid-java-sdk&utm_campaign=Badge_Grade_Dashboard"><img src="https://api.codacy.com/project/badge/Grade/9fc044b36fff4985bd69f1232380d5ee" /></a>
+               <a href="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk"><img src="https://www.codefactor.io/repository/github/WeBankFinTech/weid-java-sdk/badge" /></a>
+               <a href="https://codecov.io/gh/WeBankFinTech/weid-java-sdk"><img src="https://codecov.io/gh/WeBankFinTech/weid-java-sdk/branch/master/graph/badge.svg" /></a>
                <a href="https://www.gnu.org/licenses/lgpl-3.0"><img src="https://img.shields.io/badge/license-GNU%20LGPL%20v3.0-blue.svg" /></a>
             </td>
          </tr>

diff --git a/docs/zh_CN/conf.py b/docs/zh_CN/conf.py
@@ -268,7 +268,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'weidentity', 'WeIdentity Documentation',
+    (master_doc, 'WeIdentity', 'WeIdentity Documentation',
      [author], 1)
 ]
 

diff --git a/docs/zh_CN/docs/how-to-run-unit-test.md b/docs/zh_CN/docs/how-to-run-unit-test.md
@@ -8,7 +8,7 @@
 
 ### 流程
 
-下载源代码后，以 `weidentity-java-sdk` 根目录为起点：
+下载源代码后，以 `weid-java-sdk` 根目录为起点：
 
 1, 进入dist/conf目录。
 

diff --git a/docs/zh_CN/docs/styleguides/versioning-management.md b/docs/zh_CN/docs/styleguides/versioning-management.md
@@ -12,10 +12,10 @@
 
 SDK 搭配智能合约运行了一段时间，发现一些 bug，解决方案可能会出现下面的几种情况：
 
-1. SDK 需要升级，智能合约不升级。如果 SDK 已经有版本修复了这个 bug，并且 SDK 的版本号只有 `MINOR` 和 `PATCH` 版本号跟当前使用的 SDK 不一致，因为这类 SDK 的升级保证了向后兼容性，从而肯定能兼容当前使用的智能合约，所以可以直接升级 SDK。例如使用 `weidentity-java-sdk-v1.2.3` 的过程中遇到了 bug，然后这个 bug 在 `weidentity-java-sdk-v1.3.0` 版本中得到了修复，则可以直接升级。
+1. SDK 需要升级，智能合约不升级。如果 SDK 已经有版本修复了这个 bug，并且 SDK 的版本号只有 `MINOR` 和 `PATCH` 版本号跟当前使用的 SDK 不一致，因为这类 SDK 的升级保证了向后兼容性，从而肯定能兼容当前使用的智能合约，所以可以直接升级 SDK。例如使用 `weid-java-sdk-v1.2.3` 的过程中遇到了 bug，然后这个 bug 在 `weid-java-sdk-v1.3.0` 版本中得到了修复，则可以直接升级。
     > 注意:
-如果这个时候没有找到向后兼容的 SDK 升级版本,例如使用 `weidentity-java-sdk-v1.2.3` 的过程中遇到了 bug, 然后这个 bug 在 `weidentity-java-sdk-v2.0.1` 版本得到了修复，这个时候如果升级SDK，可能会遇到接口不兼容或者不兼容当前使用的智能合约版本的情况。这个时候可以给我们提 issue，我们可以提供特定的 bugfix 版本。
+如果这个时候没有找到向后兼容的 SDK 升级版本,例如使用 `weid-java-sdk-v1.2.3` 的过程中遇到了 bug, 然后这个 bug 在 `weid-java-sdk-v2.0.1` 版本得到了修复，这个时候如果升级SDK，可能会遇到接口不兼容或者不兼容当前使用的智能合约版本的情况。这个时候可以给我们提 issue，我们可以提供特定的 bugfix 版本。
 
-2. SDK 不需要升级，智能合约需要升级。合约的升级同样满足版本号管理的约束，例如当前使用的 `weidentity-contract-v1.4.0` 有 bug，然后这个bug在 `weidentity-contract-v1.5.2` 版本中得到了修复。则可以直接升级合约。
+2. SDK 不需要升级，智能合约需要升级。合约的升级同样满足版本号管理的约束，例如当前使用的 `weid-contract-v1.4.0` 有 bug，然后这个bug在 `weid-contract-v1.5.2` 版本中得到了修复。则可以直接升级合约。
 
 3. SDK 和智能合约都需要升级。这种情况建议两者都升级到最新的 release 版本，最新版本的 SDK 一定兼容最新版本的智能合约。
diff --git a/docs/zh_CN/docs/weidentity-rest-design.rst b/docs/zh_CN/docs/weidentity-rest-design.rst
@@ -26,19 +26,19 @@ RestService架构包括以下模块：
 
 * 用户应用：用户的业务app应用，发送HTTP请求
 * rest-server：Server服务器端
-* weidentity-java-sdk：WeIdentity的SDK
+* weid-java-sdk：WeIdentity的SDK
 
 2.2 交易模型
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 过去的做法是：
 
-* 用户传入接口参数（包括私钥），直接调用RESTful接口，weidentity-http-service调用sdk然后发送交易；
+* 用户传入接口参数（包括私钥），直接调用RESTful接口，weid-http-service调用sdk然后发送交易；
 
 改造后：
 
-* 用户应用调传入自己的私钥索引以指明自己使用哪个私钥，然后POST /weid/api/invokeTransaction，发送请求给weidentity-http-service
-* weidentity-http-service接受请求，依据索引载入所托管的私钥，调用weidentity-java-sdk的对应方法，发送交易给区块链节点
+* 用户应用调传入自己的私钥索引以指明自己使用哪个私钥，然后POST /weid/api/invokeTransaction，发送请求给weid-http-service
+* weid-http-service接受请求，依据索引载入所托管的私钥，调用weid-java-sdk的对应方法，发送交易给区块链节点
 
 3. 调用时序说明
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^