modify changelog

modify index.rst of changelog modify index.rst modify index.rst modify 2.0-rc1.md modify changelog decriptions modify changelog decriptions fix fix format fix link
luleigreat · May 8, 2019 · 82c7740 · 82c7740
1 parent 598be4e
commit 82c7740
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 136 deletions.
diff --git a/docs/changelog/2.0-rc1.md b/docs/changelog/2.0-rc1.md
@@ -1,60 +1,48 @@
 # [FISCO BCOS 2.0.0-rc1](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.0.0-rc1)
 
-## 变更描述
+```eval_rst
+.. admonition:: v1.0升级到v2.0.0-rc1
 
-**架构**
+    - **v2.0.0-rc2不兼容v1.0，v1.0无法直接将数据迁移到v2.0.0-rc1** ，但可通过在v2.0.0-rc2的新链上执行历史交易的方式恢复旧数据
 
-- Add
+    - **搭建2.0的新链** ：请参考 `安装 <./installation.html>`_ 
+```
 
-1. 新增群组架构，各群组独立共识和存储，在较低运维成本基础上实现系统吞吐能力横向扩展。
-2. 新增分布式数据存储，支持节点将数据存储在远端分布式系统中，实现计算与数据隔离、高速扩容、数据安全等级提升等目标。
-3. 新增对预编译合约的支持，底层基于C++实现预编译合约框架，兼容solidity调用方式，提升智能合约执行性能。
-4. 引入evmc扩展框架，支持扩展不同虚拟机引擎。
+## 变更描述
 
-- Update
+**架构**
 
-1. 升级重塑P2P、共识、同步、交易执行、交易池、区块管理模块。
+1. [新增群组架构](../design/architecture/group.md)：各群组独立共识和存储，在较低运维成本基础上实现系统吞吐能力横向扩展。
+2. [新增分布式数据存储](../design/storage/storage.md)：支持节点将数据存储在远端分布式系统中，实现计算与数据隔离、高速扩容、数据安全等级提升等目标。
+3. [新增对预编译合约的支持](../design/virtual_machine/precompiled.md)：底层基于C++实现预编译合约框架，兼容solidity调用方式，提升智能合约执行性能。
+4. [引入evmc扩展框架](../design/virtual_machine/index.md)：支持扩展不同虚拟机引擎。
+5. 升级重塑[P2P](..//design/p2p/p2p.md)、[共识](../design/consensus/index.md)、[同步](../design/sync/sync.md)、[交易执行](../design/virtual_machine/index.md)、交易池、区块管理模块。
 
 **协议**
 
-- Add
-
-1. 实现一套CRUD基本数据访问接口规范合约，基于CRUD接口编写业务合约，实现传统面向SQL方式的业务开发流程。
+1. 实现一套[CRUD](../tutorial/sdk_application.md)基本数据访问接口规范合约，基于CRUD接口编写业务合约，实现传统面向SQL方式的业务开发流程。
 2. 支持交易上链异步通知、区块上链异步通知以及自定义的AMOP消息通知等机制。
-
-- Update
-
-1. 升级以太坊虚拟机版本，支持Solidity 0.5.2版本。
-2. 升级RPC模块。
+3. 升级以太坊虚拟机版本，支持Solidity 0.5.2版本。
+4. 升级[RPC模块](../api.md)。
 
 **安全**
 
-- Update
-
-1. 升级落盘加密，提供密钥管理服务。开启落盘加密功能时，依赖KeyManager服务进行密钥管理。
-2. 升级准入机制，通过引入网络准入机制和群组准入机制，在不同维度对链和数据访问进行安全控制。
-3. 升级权限控制体系，基于表进行访问权限的设计。
+1. 升级[落盘加密](../manual/storage_security.md)，提供密钥管理服务。开启落盘加密功能时，依赖KeyManager服务进行密钥管理。
+2. 升级[准入机制](../manual/node_management.md)，通过引入网络准入机制和群组准入机制，在不同维度对链和数据访问进行安全控制。
+3. 升级[权限控制体系](../manual/permission_control.md)，基于表进行访问权限的设计。
 
 **其他**
 
-- Add
-
-1. 提供入门级的搭链工具。
+1. 提供入门级的[搭链工具](../manual/build_chain.md)。
 2. 提供模块化的单元测试和端对端集成测试，支持自动化持续集成和持续部署。
 
 ## 兼容性说明
 
 |           | 兼容版本                                            | 说明                                                         |
 | --------- | --------------------------------------------------- | ------------------------------------------------------------ |
-| 节点      | 向下兼容 FISCO BCOS 2.0.0 rc1，不兼容FISCO BCOS 1.x | 2.0版本与1.x版本完全不兼容。2.0版本不能直接跑在1.0的数据上，也不能和1.0的节点相互通信。 |
+| 节点      | 不兼容FISCO BCOS 1.x | 2.0版本与1.x版本完全不兼容 <br> 2.0版本不能直接跑在1.0的数据上，也不能和1.0的节点相互通信。 |
 | 控制台    | 1.0.0+                                              |                                                              |
 | Web3SDK   | 2.0.0-rc1+                                          |                                                              |
 | generator | 1.0.0-rc1                                           |                                                              |
 | 浏览器    | 2.0.0-rc1+                                          |                                                              |
-| Solidity  | 最高支持 solidity 0.5.2                             |                                                              |
-
-## 升级说明
-
-**从1.0升级到2.0.0-rc1**
-
-1.0无法直接将数据迁移到2.0上来，只能依靠外部的方式，将历史的交易重放到2.0的新链上。搭建2.0的新链，请参考[安装](./installation.md)部分。
+| Solidity  | 最高支持 solidity 0.5.2                             |                                                              |
diff --git a/docs/changelog/2.0-rc2.md b/docs/changelog/2.0-rc2.md
@@ -1,35 +1,44 @@
 # [FISCO BCOS 2.0.0-rc2](https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.0.0-rc2)
 
+```eval_rst
+.. admonition:: v2.0.0-rc1升级到v2.0.0-rc2
+
+    - **兼容升级** ：直接替换v2.0.0-rc1节点的二进制为v2.0.0-rc2二进制，升级后的版本修复v2.0.0-rc1中的bug，但不会启用v2.0.0-rc2并行计算、分布式存储等新特性， **升级后，不可再将rc2的二进制替换回rc1**
+
+    - **全面升级** ：参考 `安装 <../installation.html>`_ 搭建新链，重新向新节点提交所有历史交易，升级后节点包含v2.0.0-rc2新特性
+```
+
 ## 变更描述
 
 **New Feature**
 
-* 并行计算模型：可并行合约开发框架、交易并行执行引擎（PTE）
-* 分布式存储：AMDB、SQLStorage
+* [并行计算模型](../manual/transaction_parallel.md)：可并行合约开发框架、交易并行执行引擎（PTE）
+* [分布式存储](../manual/amdbconfig.md)：AMDB、SQLStorage
 
 **Update**
 
-* 优化了区块打包交易数的逻辑，根据执行时间动态的调整区块打包交易数
+* 优化了[区块打包交易数](../manual/configuration.html#id15)的逻辑，根据执行时间动态的调整区块打包交易数
 * 优化了区块同步的流程，让区块同步更快
 * 并行优化了将交易的编解码、交易的验签和落盘的编码
 * 优化了交易执行返回码的逻辑，让返回码更准确
 * 升级了存储模块，支持并发读写
 
 **Add**
 
-* 加入[网络数据包压缩](<https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/design/features/network_compress.html>)
-* 加入[兼容性配置](<https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/configuration.html#id7>)
+* 加入[网络数据包压缩](../design/features/network_compress.md)
+* 加入[兼容性配置](../manual/configuration.html#id7>)
 * 交易编码中加入chainID和groupID
 * 交易中加入二进制缓存
 * 创世块中加入timestamp信息
 * 增加了一些precompile的demo
-* 支持用Docker搭链
+* 支持用[Docker搭链](../manual/build_chain.md)
 
 **Fix**
 
-* RPC中处理参数时asInt异常造成程序退出的bug
-* 交易执行Out of gas时交易一直在交易池中不被处理的bug
-* 不同组间可以用相同的交易二进制重放的bug
+* [RPC中处理参数时asInt异常造成程序退出的bug](
+https://security.webank.com/report/freelink/932/6673f4de1e4c4acaf69a0ebb474545a0)
+* [交易执行Out of gas时交易一直在交易池中不被处理的bug](https://security.webank.com/report/freelink/871/cbb01ea45c9d2324c311f4f6fc1ec7ef)
+* [不同组间可以用相同的交易二进制重放的bug](https://security.webank.com/report/freelink/870/880c699de2f2d87bdf69c189d0ca42cd)
 * insert操作造成的性能衰减问题
 * 一些稳定性修复
 
@@ -42,21 +51,12 @@
 
 |           | 兼容版本                                            | 说明                                                         |
 | --------- | --------------------------------------------------- | ------------------------------------------------------------ |
-| 节点      | 向下兼容 FISCO BCOS 2.0.0 rc1，不兼容FISCO BCOS 1.x | 此版本可直接跑在v2.0.0-rc1的配置和数据上，但不会有此版本的新特性，仅仅相当于稳定性提升。若需要用此版本的新特性，需重新搭链。 |
+| 节点      | 向下兼容 FISCO BCOS v2.0.0-rc1<br>不兼容FISCO BCOS 1.x | 可运行于v2.0.0-rc1节点<br>v2.0.0-rc1节点无法使用v2.0.0-rc2新特性，但可提升稳定性 <br> 若需要用此版本的新特性，需重新搭链。 |
 | 控制台    | 1.0.2+                                              |                                                              |
 | Web3SDK   | 2.0.0-rc2+                                          |                                                              |
 | generator | 1.0.0-rc2                                           |                                                              |
 | 浏览器    | 2.0.0-rc2+                                          |                                                              |
 | Solidity  | 最高支持 solidity 0.5.2                             |                                                              |
 | AMDB      | 2.0.0+                                              |                                                              |
 
-## 升级说明
-
-**从1.0升级到2.0.0-rc2**
-
-1.0无法直接将数据迁移到2.0上来，只能依靠外部的方式，将历史的交易重放到2.0的新链上。搭建2.0的新链，请参考[安装](./installation.md)部分。
-
-**从2.0 rc1升级到2.0.0-rc2**
 
-* 兼容模式的升级：rc2提供了兼容模式。可直接将rc1的节点二进制替换成rc2的节点二进制完成升级。升级后能修复rc1中的bug，但不会启用rc2的新特性（并行计算模型，分布式存储）。升级后，不可再将rc2的二进制替换回rc1。
-* 使用新特性的升级：先参考[安装](./installation.md)部分搭建新链，再用外部的方式将交易重放到2.0 rc2的新链上。
diff --git a/docs/changelog/index.md b/docs/changelog/index.md
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -0,0 +1,46 @@
+##############################################################
+版本及兼容
+##############################################################
+
+.. admonition:: `FISCO BCOS 1.0 Releases <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v1.0.0>`_
+
+    **FISCO BCOS 1.0 Releases:** https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v1.0.0
+
+.. admonition:: `FISCO BCOS 2.0.0-rc1 <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.0.0-rc1>`_
+
+     **新增特性**
+      - `群组架构 <../what_is_new.html#id2>`_ (`操作教程 <../tutorial/group_use_cases.html>`_ ) (`设计文档 <../design/architecture/group.html>`_ )
+      - `控制台 <../what_is_new.html#id6>`_ (`安装 <../installation.html#id7>`_ ) (`操作手册 <..//manual/console.html>`_ )
+      - `虚拟机 <../what_is_new.html#id7>`_ 
+      - `编译合约 <../what_is_new.html#id5>`_ (`合约开发 <../manual/smart_contract.html>`_ )
+      - `CRUD合约 <../what_is_new.html#crud>`_ (`操作教程 <../tutorial/sdk_application.html>`_ )
+      - `密钥管理服务 <../what_is_new.html#id8>`_ (`KeyManager <../manual/storage_security.html>`_ )
+      - `准入控制 <../what_is_new.html#id9>`_ (`设计文档 <../manual/node_management.html>`_ )
+
+     **变更描述、兼容及升级说明**
+      - `FISCO BCOS 2.0 rc1 <./2.0-rc1.html>`_
+
+
+.. admonition:: `FISCO BCOS 2.0.0-rc2 <https://github.com/FISCO-BCOS/FISCO-BCOS/releases/tag/v2.0.0-rc2>`_
+
+     **新增特性**
+      - `并行计算模型 <../what_is_new.html#id4>`_ (`操作手册 <../manual/transaction_parallel.html>`_ ) (`设计文档 <../tutorial/group_use_cases.html>`_ )
+      - `分布式存储 <../what_is_new.html#id3>`_ (`操作手册 <../manual/amdbconfig.html>`_ )
+
+     **变更描述、兼容及升级说明**
+      - `FISCO BCOS 2.0 rc2 <./2.0-rc2.html>`_
+
+.. admonition:: 查看节点和数据版本
+
+    - 查看节点二进制版本：``./fisco-bcos --version``
+    - 数据的版本：通过配置文件 `config.ini的supported_version配置项 <../manual/configuration.html#id7>`_ 获取
+
+
+.. toctree::
+   :maxdepth: 1
+
+   2.0-rc1.md
+   2.0-rc2.md
+
+
+
diff --git a/index.rst b/index.rst
@@ -15,13 +15,13 @@ FISCO BCOS 是一个稳定、高效、安全的区块链底层平台，经过了
 
    docs/introduction.md
    docs/what_is_new.md
+   docs/changelog/index.rst
    docs/installation.md
    docs/tutorial/index.rst
    docs/manual/index.rst
    docs/enterprise_tools/index.md
    docs/design/index.rst
    docs/sdk/sdk.md
    docs/api.md
-   docs/changelog/index.md
    docs/faq.md
    docs/community.md