Skip to content

Commit

Permalink
fix descriptions (#771)
Browse files Browse the repository at this point in the history
  • Loading branch information
cyjseagull committed Mar 23, 2020
1 parent 1b87664 commit 520e930
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 15 deletions.
6 changes: 3 additions & 3 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,17 +99,17 @@ def _patched_fetch_urls(lfs_url, oid_list):

# General information about the project.
project = u'FISCO BCOS'
copyright = u'© 2019. All rights reserved.'
copyright = u'© 2020. All rights reserved.'
author = u'fisco-bcos-dev'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2.2'
version = '2.3'
# The full version, including alpha/beta/rc tags.
release = 'v2.2.0'
release = 'v2.3.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 2 additions & 2 deletions docs/change_log/2_3_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@

- [同态加密](../manual/privacy.html#id2):链上支持同态加密功能,启用该功能可参考[这里](../manual/privacy.html#id12)
- [群环签名](../manual/privacy.html#id7): 链上支持群签名验证和环签名验证,并提供群环签名[服务端](https://github.com/FISCO-BCOS/group-signature-server)[客户端](https://github.com/FISCO-BCOS/group-signature-client) Demo,实现群环签名机构内生成、上链和链上验证功能
- [RPBFT](../design/consensus/rpbft.md):基于PBFT共识算法,实现一种新型的共识算法RPBFT,尽量减少节点规模对共识算法的影响
- [RPBFT](../design/consensus/rpbft.md):基于PBFT共识算法,实现一种新型的共识算法RPBFT,尽量减少节点规模对共识算法的影响,配置RPBFT请参考[共识配置](../manual/configuration.html#id10)[RPBFT共识配置](../manual/configuration.html#rpbft)
- [KVTable](../manual/smart_contract.html#kvtable):提供基于键值型数据读写方式,相较于[Table合约的CRUD接口](../manual/smart_contract.html#tablecrud),更加简单易用、容易维护
- [合约管理功能](../design/features/contract_management.md):提供合约生命周期管理接口,包括合约的[冻结](../manual/console.html#freezecontract)[解冻](../manual/console.html#unfreezecontract)[合约状态查询](../manual/console.html#getcontractstatus)及其相关的[授权](../manual/console.html#grantcontractstatusmanager)[权限查询](../manual/console.html#listcontractstatusmanager)等操作,方便运维人员对上链合约的管理


**更新**

- [rpc.listen_ip拆分成channel_listen_ip和jsonrpc_listen_ip](../manual/configuration.html#rpc)
- 暴露合约表写权限控制接口,包括合约表写权限[授权](../manual/console.html#grantcontractwritepermission)[撤回](../manual/console.html#revokecontractwritepermission)[查询](../manual/console.html#listcontractwritepermission)
- 提供合约写权限控制接口,包括合约写权限[授权](../manual/console.html#grantcontractwritepermission)[撤回](../manual/console.html#revokecontractwritepermission)[查询](../manual/console.html#listcontractwritepermission)
- [简化并行交易配置](../manual/configuration.html#id25)
- [推荐使用MySQL直连的存储模式替代External存储模式](../manual/configuration.html#storage)

Expand Down
2 changes: 1 addition & 1 deletion docs/design/consensus/rpbft.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ RPBFT算法目前实现中,轮流将共识委员列表节点替换为验证节
- 网络复杂度:O(epoch_sealer_num * epoch_sealer_num),与节点规模无关,可扩展性强于PBFT共识算法
- 性能:可秒级确认,且由于算法复杂度与节点数无关,性能衰减远小于PBFT
- 一致性、可用性要求:需要至少三分之二的共识委员节点正常工作,系统才可正常共识
- 安全性:未来可引入VRF算法,随机、私密地替换共识委员,增强共识算法安全性
- 安全性:未来将引入VRF算法,随机、私密地替换共识委员,增强共识算法安全性


## RPBFT网络优化
Expand Down
6 changes: 3 additions & 3 deletions en/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,17 @@ def _patched_fetch_urls(lfs_url, oid_list):

# General information about the project.
project = u'FISCO BCOS EN'
copyright = u'© 2019. All rights reserved.'
copyright = u'© 2020. All rights reserved.'
author = u'fisco-dev'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2.2'
version = '2.3'
# The full version, including alpha/beta/rc tags.
release = 'v2.2.0'
release = 'v2.3.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 2 additions & 2 deletions en/docs/change_log/2_3_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

- [Group Signature](https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-2.3.0/docs/manual/privacy.html#id7): v2.3.0 supports group signature verification and ring signature verification, provides [group signature server](https://github.com/FISCO-BCOS/group-signature-server) and [group signature client](https://github.com/FISCO-BCOS/group-signature-client) demo to realize the group signature generation, on-chain and on-chain verification.

- [RPBFT](https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-2.3.0/docs/design/consensus/rpbft.html): Based on the PBFT consensus algorithm, a new consensus algorithm RPBFT is implemented to minimize the impact of node size on the consensus algorithm
- [RPBFT](https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-2.3.0/docs/design/consensus/rpbft.html): Based on the PBFT consensus algorithm, a new consensus algorithm RPBFT is implemented to minimize the impact of node size on the consensus algorithm, To configure RPBFT, please refer to [Consensus Configuration](../manual/configuration.html#consensus-configuration) and [RPBFT Consensus Configuration](../manual/configuration.html#rpbft-consensus-configurations)

- [KVTable](../manual/smart_contract.html#use-kvtable-contract-get-set-interface):Provides key-based data reading and writing methods. Compared to [Table contract CRUD interface](../manual/smart_contract.html#to-use-table-contract-crud-interface), it is simpler and easier to use and maintain.

Expand All @@ -28,7 +28,7 @@
**Update**

- [rpc.listen_ip split into channel_listen_ip and jsonrpc_listen_ip](../manual/configuration.html#configure-rpc)
- Expose contract table write permission control interface, including contract table write permission [authorization](../manual/console.html#grantcontractwritepermission)[revoke](../manual/console.html#revokecontractwritepermission)[query](../manual/console.html#listcontractwritepermission)
- Provide contract write permission control interface, including contract write permission [authorization](../manual/console.html#grantcontractwritepermission)[revoke](../manual/console.html#revokecontractwritepermission)[query](../manual/console.html#listcontractwritepermission)
- [Simplify parallel transaction configuration](../manual/configuration.html#parallel-transaction-configuration)
- [recommended to use MySQL directly connected storage mode instead of External storage mode](../manual/configuration.html#configure-storage)

Expand Down
4 changes: 0 additions & 4 deletions en/docs/manual/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,6 @@ id=2

- `node.idx`:consensus node list, has configured with the [Node ID] of the participating consensus nodes. The Node ID can be obtained by the `${data_path}/node.nodeid` file (where `${data_path}` can be obtained by the configuration item `[secure].data_path` of the main configuration `config.ini`)


FISCO BCOS v2.3.0引入了RPBFT共识算法,具体可参考[这里](../design/consensus/rpbft.md),RPBFT相关配置如下:

FISCO BCOS v2.3.0 introduced the RPBFT consensus algorithm, The RPBFT related configuration is as follows:

- `epoch_sealer_num`:The number of nodes participating in the consensus is selected in a consensus period. The default is the total number of all consensus nodes. After the chain is initialized, this parameter can be dynamically adjusted through [Console] (./console.html#setsystemconfigbykey)
Expand Down Expand Up @@ -497,7 +494,6 @@ broadcast_prepare_by_tree=true
; Only effective when the prepare package tree broadcast is enabled
; Each node randomly selects 33% consensus nodes to synchronize the prepare packet status
prepare_status_broadcast_percent=33
; prepare包树状广播策略下,缺失prepare包的节点超过100ms没等到父节点转发的prepare包,会向其他节点请求缺失的prepare包
; Under the prepare package tree broadcast strategy,
; the node missing the prepare package takes more than 100ms and
; does not wait for the prepare package forwarded by the parent node
Expand Down

0 comments on commit 520e930

Please sign in to comment.