Merge pull request #1184 from MaggieNgWu/dev

add more reference
FISCO-BCOS · Mar 11, 2021 · b3ea808 · b3ea808
2 parents aa48929 + f2a25ae
commit b3ea808
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 9 deletions.
diff --git a/docs/blockchain_dev/config.rst b/docs/blockchain_dev/config.rst
@@ -2,6 +2,12 @@
 配置管理
 ##############################################################
 
+.. important::
+    进行配置管理前请确保您已经存在一条搭建好的区块链网络。
+    快速建链：请参考 `搭建第一个区块链网络 <../installation.html>`_ 
+    更丰富的区块链网络搭建方式： 请参考 `构建和管理区块链网络>网络搭建 <env.html>`_ 
+    建链工具参考：`开发部署工具 <../manual/build_chain.html>`_ 或 `运维部署工具 <../enterprise_tools/index.html>`_。
+
 - `节点配置 <../manual/configuration.html>`_ 介绍了节点和账本配置方法，包括端口、证书、日志、群组、共识、存储、交易池、同步、流控等配置项。
 - `组员配置 <../manual/node_management.html>`_ 介绍了组员节点的加入和推出方法，包括节点加入/退出网络、节点加入/推出群组、转化成共识节点、观察者节点及游离节点等操作。
 - `配置CA黑白名单 <../manual/certificate_list.html>`_ 介绍了如何通过配置CA黑白名单，实现拒绝与无关的链的节点或指定节点建立连接，或实现仅允许与白名单中的节点建立链接。

diff --git a/docs/blockchain_dev/env.rst b/docs/blockchain_dev/env.rst
@@ -2,9 +2,9 @@
 网络搭建
 ##############################################################
 
-.. admonition::提示
+.. important::
 
-   如果您希望快速搭建一个区块链网络，推荐您参考“快速开始” > " `搭建第一个区块链网络<../installation.html>`_ "。
+   如果您希望快速搭建一个区块链网络，推荐您参考“快速开始” > " `搭建第一个区块链网络<../installation.html>`_ "。建链工具可参考`开发部署工具 <../manual/build_chain.html>`_ 或 `运维部署工具 <../enterprise_tools/index.html>`_。
 
 本章提供了丰富的FISCO BCOS区块链网络搭建教程。
 
@@ -19,6 +19,7 @@
 - 我们支持采用第三方证书部署节点，如有需要请参考 `使用CFCA证书部署节点 <../tutorial/cfca.html>`_ 。
 - `使用MySQL存储引擎 <../tutorial/cfca.html>`_ 搭建区块链网络。
 - 搭建 `使用国密算法 <../manual/guomi_crypto.html>`_ 的区块链网络。
+
 
 .. toctree::
    :hidden:

diff --git a/docs/blockchain_dev/maintain.rst b/docs/blockchain_dev/maintain.rst
@@ -5,7 +5,7 @@
 - `Caliper压力测试指南 <../tutorial/caliper.html>`_ 介绍了如何使用Caliper对FISCO BCOS区块链网络进行压力测试。
 - `查看日志 <../manual/log_description.html>`_ 介绍了日志格式和各关键步骤的日志样式，帮助您了解节点运行情况及排查问题。
 - `极端异常下的共识恢复应急方案 <../manual/consensus_recover.html>`_ 介绍由于网络脑裂、节点网络中断、节点硬件崩溃等极端情况，导致PBFT网络共识异常的情况下，恢复区块链网络的方法。
-- `海量数据治理<../manual/data_governance.html>`_ 介绍了一种本地+远端数据仓库的联合区块链数据存储方式。当节点本地存储资源不足或运行过慢的情况下可开启此海量数据治理功能。开启后，可裁剪本地数据从而加快存储，当需要访问被裁剪的数据时，即可访问保存有全量数据的远端数据仓库。
+- `海量数据治理 <../manual/data_governance.html>`_ 介绍了一种本地+远端数据仓库的联合区块链数据存储方式。当节点本地存储资源不足或运行过慢的情况下可开启此海量数据治理功能。开启后，可裁剪本地数据从而加快存储，当需要访问被裁剪的数据时，即可访问保存有全量数据的远端数据仓库。
 
 .. toctree::
    :hidden:

diff --git a/docs/console/console.md b/docs/console/console.md
@@ -16,7 +16,8 @@
 
 ```eval_rst
 .. important::
-    前置条件：搭建FISCO BCOS区块链请参考 `开发部署工具 <../manual/build_chain.html>`_ 或 `企业工具 <../enterprise_tools/index.html>`_。
+    前置条件：搭建FISCO BCOS区块链，请参考 `搭建第一个区块链网络 <../installation.html>`_
+    建链工具参考：`开发部署工具 <../manual/build_chain.html>`_ 或 `运维部署工具 <../enterprise_tools/index.html>`_。
 ```
 
 ### 获取控制台

diff --git a/docs/console/console_of_java_sdk.md b/docs/console/console_of_java_sdk.md
@@ -16,7 +16,8 @@
 
 ```eval_rst
 .. important::
-    前置条件：搭建FISCO BCOS区块链请参考 `开发部署工具 <../manual/build_chain.html>`_ 或 `企业工具 <../enterprise_tools/index.html>`_。
+    前置条件：搭建FISCO BCOS区块链，请参考 `搭建第一个区块链网络 <../installation.html>`_
+    建链工具参考：`开发部署工具 <../manual/build_chain.html>`_ 或 `运维部署工具 <../enterprise_tools/index.html>`_。
 ```
 
 ### 获取控制台

diff --git a/docs/console/index.rst b/docs/console/index.rst
@@ -13,6 +13,11 @@
     - 可通过命令 ``./start.sh --version`` 查看当前控制台版本
     - 基于 `Java SDK <../sdk/java_sdk/index.html>`_ 开发应用过程中将 ``solidity`` 代码转换为 ``java`` 代码时，必须使用 ``2.6+`` 版本控制台，具体请参考  `这里 <../console/download_console.html>`_ 
 
+.. important::
+    前置条件：搭建FISCO BCOS区块链，请参考 `搭建第一个区块链网络 <../installation.html>`_
+    建链工具参考：`开发部署工具 <../manual/build_chain.html>`_ 或 `运维部署工具 <../enterprise_tools/index.html>`_。
+
+
 .. toctree::
    :maxdepth: 1
 

diff --git a/docs/manual/amop_protocol.md b/docs/manual/amop_protocol.md
@@ -14,8 +14,6 @@
 
 AMOP功能使用请参照[Java SDK AMOP](../sdk/java_sdk/amop.html).
 
-
-
 ## 逻辑架构
 
 ![](../../images/sdk/AMOP.jpg)
@@ -55,7 +53,10 @@ AMOP的消息收发基于话题（Topic）订阅机制，订阅者首先订阅
 - 1：接收者使用[生成公私钥脚本](./account.md)生成公私钥文件，私钥保留，公钥给生产者。
 - 2：参考配置案例将配置文件配好。启动接收端和发送端进行收发消息。
 
-
+```eval_rst
+.. important::
+    注意：AMOP私有话题目前只支持非国密算法，因此生成在生成公私钥文件时，注意使用非国密工具生成。
+```
 
 **私有话题的认证流程**
 

diff --git a/docs/sdk/java_sdk/amop.md b/docs/sdk/java_sdk/amop.md
@@ -15,6 +15,12 @@ AMOP私有话题的特别之处在于，SDK间需要进行了身份认证，认
 
 当用户需要订阅私有话题，或者作为消息发布者配置一个私有话题时，可用配置文件进行配置。但AMOP的配置不是必须项，私有话题的订阅和设置，还可以通过调用AMOP的接口实现。以下是AMOP的配置示例，是``test/resource/config-example.toml``配置文件中的一部分。
 
+```eval_rst
+.. important::
+    注意：AMOP私有话题目前只支持非国密算法。
+    请使用 `生成公私钥脚本 <./account.md>_ 生成非国密公私钥文件.
+```
+
 ```toml
 # AMOP configuration
 # You can use following two methods to configure as a private topic message sender or subscriber.
@@ -61,7 +67,7 @@ AMOP私有话题的特别之处在于，SDK间需要进行了身份认证，认
    privateKey = "conf/amop/consumer_private_key.p12"
    password = "123456"
    ```
-
+  
 
 
 ## 2. 接口说明