From 021208f51ac2d53ff3163c02167862b192c90537 Mon Sep 17 00:00:00 2001 From: Laertes Date: Mon, 12 Dec 2022 16:30:03 +0800 Subject: [PATCH 1/5] update v5.3branch (#254) --- source/advanced_usage/multi_nodes.rst | 3 +- .../performance_introduction.rst | 2 +- source/advanced_usage/release.rst | 43 ------------------- source/conf.py | 11 +++-- source/index.rst | 1 + source/more_materials/release.rst | 18 ++++++++ source/quickstart/quickstart.rst | 4 +- source/tree.rst | 1 + 8 files changed, 30 insertions(+), 53 deletions(-) delete mode 100644 source/advanced_usage/release.rst create mode 100644 source/more_materials/release.rst diff --git a/source/advanced_usage/multi_nodes.rst b/source/advanced_usage/multi_nodes.rst index b3601aeb..58518f9f 100644 --- a/source/advanced_usage/multi_nodes.rst +++ b/source/advanced_usage/multi_nodes.rst @@ -197,6 +197,7 @@ # KeyPath is the netdisk private key path keyPath: netkeys # BootNodes config the bootNodes the node to connect + # BootNodes 也可以选择都链接同一个节点，再启动网络时需要先启动该节点 bootNodes: - "/ip4/127.0.0.1/tcp/47101/p2p/Qmf2HeHe4sspGkfRCTq6257Vm3UHzvh2TeQJHHvHzzuFw6" - "/ip4/127.0.0.1/tcp/47102/p2p/QmQKp8pLWSgV4JiGjuULKV1JsdpxUtnDEUMP8sGaaUbwVL" @@ -204,7 +205,7 @@ # service name serviceName: localhost -.. note:: 注意: 如果您是部署在同一个节点上，p2p模块端口应该配置不同，同时不要和其他已经被占用的端口冲突 +.. note:: 注意: 如果您是部署在同一个服务器上，p2p模块端口应该配置不同，同时不要和其他已经被占用的端口冲突 .. _net-start: diff --git a/source/advanced_usage/performance_introduction.rst b/source/advanced_usage/performance_introduction.rst index 536fd33e..e7e5bae7 100644 --- a/source/advanced_usage/performance_introduction.rst +++ b/source/advanced_usage/performance_introduction.rst @@ -19,7 +19,7 @@ xuperchain网络搭建 git clone https://github.com/xuperchain/xuperchain.git cd xuperchain - git checkout -b v5.1.0 v5.1.0 + git checkout -b v5.3.0 v5.3.0 make make testnet diff --git a/source/advanced_usage/release.rst b/source/advanced_usage/release.rst deleted file mode 100644 index 7b57840a..00000000 --- a/source/advanced_usage/release.rst +++ /dev/null @@ -1,43 +0,0 @@ -下载发行版 -============= - -v3.10 ->>>>>>>>>>>>>> - -版本说明 ----------- - -* 智能合约 - - * XuperChain VM 支持 EVM - * XuperChain 支持 solidity 合约的部署和调用 - -* 对等网络 - - * 支持 TLS 和 IPv6 - -* 内核 - - * 新的交易哈希算法 - -* 命令行 - - * 支持发送需要背书的交易 - -* 其他 - - * 新增 JAVA SDK - * 修复平行链的 BUG - * 修复 SMR 模块的 BUG - * 其他 BUG 修复 - -* 文档 - * 新增 XuperChain EVM 合约文档 - * 其他文档优化 - -下载 -------- - - * Linux: `xuperchain-linux-amd64-v3.10.tar.gz `_ - * MacOS: `xuperchain-darwin-amd64-v3.10.tar.gz `_ - * 源代码: `xuperchain-source-v3.10.tar.gz `_ \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index cb55016f..3b14ccbe 100644 --- a/source/conf.py +++ b/source/conf.py @@ -20,13 +20,13 @@ # -- Project information ----------------------------------------------------- project = u'XuperChain 官方文档' -copyright = u'2021, xuper' +copyright = u'2022, xuper' author = u'xuper' # The short X.Y version -version = u'5.1' +version = u'5.3' # The full version, including alpha/beta/rc tags -release = u'' +release = u'5.3' # -- General configuration --------------------------------------------------- @@ -137,7 +137,6 @@ # -- Options for manual page output ------------------------------------------ - # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples @@ -166,9 +165,9 @@ "display_github": True, # Integrate GitHub "github_user": "xuperchain", # Username "github_repo": "docs", # Repo name - "github_version": "master", # Version + "github_version": "v5.3", # Version "conf_py_path": "/source/", # Path in the checkout to the docs root } html_css_files = [ - "custom.css" + "custom.css" ] diff --git a/source/index.rst b/source/index.rst index 37ae3f08..f5b144c8 100644 --- a/source/index.rst +++ b/source/index.rst @@ -120,3 +120,4 @@ XuperChain文档 more_materials/code_explanation.rst more_materials/config_explanation.rst more_materials/video.rst + more_materials/release.rst diff --git a/source/more_materials/release.rst b/source/more_materials/release.rst new file mode 100644 index 00000000..6ef9ef08 --- /dev/null +++ b/source/more_materials/release.rst @@ -0,0 +1,18 @@ + +下载发行版 +======== + +最新版本 +^^^^^^^^^^^^^^ + +v5.3 +>>>>>>>>>>>>>> + + * Linux: `xuperchain-linux-amd64-v5.3.zip `_ + * MacOS: `xuperchain-darwin-amd64-v5.3.zip `_ + + +历史版本 +^^^^^^^^^^^^^^ + +github: https://github.com/xuperchain/xuperchain/releases \ No newline at end of file diff --git a/source/quickstart/quickstart.rst b/source/quickstart/quickstart.rst index 85522a29..245a7da4 100644 --- a/source/quickstart/quickstart.rst +++ b/source/quickstart/quickstart.rst @@ -13,7 +13,7 @@ XuperChain主要由Golang开发，需要首先准备编译运行的环境 -- 安装go语言编译环境，推荐使用的版本为1.14或1.15 +- 安装go语言编译环境，推荐使用的版本为 1.5 - 1.8(不包含) - 下载地址：`golang `_ - 安装git - 下载地址：`git `_ @@ -34,7 +34,7 @@ XuperChain主要由Golang开发，需要首先准备编译运行的环境 .. code-block:: bash $ cd xuperchain - $ git checkout -b v5.1.0 v5.1.0 + $ git checkout -b v5.3.0 v5.3.0 $ make - 在output目录得到bin，conf， data 三个文件夹以及一个 control.sh 脚本 diff --git a/source/tree.rst b/source/tree.rst index 9cda6651..8623e06c 100644 --- a/source/tree.rst +++ b/source/tree.rst @@ -90,3 +90,4 @@ XuperChain文档 more_materials/code_explanation.rst more_materials/config_explanation.rst more_materials/video.rst + more_materials/release.rst From a76ac81567212fe65b33d8d47d84f867208d1e88 Mon Sep 17 00:00:00 2001 From: litian Date: Mon, 27 Feb 2023 11:29:49 +0800 Subject: [PATCH 2/5] fix some links (#265) --- source/design_documents/consensus/tdpos.rst | 2 +- source/xuperos/xuperos_go.rst | 2 +- source/xuperos/xuperos_java.rst | 2 +- source/xuperos/xuperos_js.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/design_documents/consensus/tdpos.rst b/source/design_documents/consensus/tdpos.rst index 451aad89..2757228c 100644 --- a/source/design_documents/consensus/tdpos.rst +++ b/source/design_documents/consensus/tdpos.rst @@ -71,7 +71,7 @@ TDPoS类共识矿工轮转通过时间片来划分，当验证人确定之后， 节点想要参与竞选，需要先被提名到候选人池，只有被提名的地址才能接受投票。系统中所有拥有 **治理Token** 的节点均可参与提名和投票。为了收敛候选人集合，并一定程度上增加候选人参与的门槛，提名为候选人会有很多规则，主要有以下几点： -- 提名候选人需要治理Token，详见 `治理Token <../governance.html#xuperchain>`_ 。 +- 提名候选人需要治理Token，详见 `治理Token <<../../advanced_usage/governance.html#token>>`_ 。 - 该治理Token会被一直冻结，直到节点退出候选池。 diff --git a/source/xuperos/xuperos_go.rst b/source/xuperos/xuperos_go.rst index d357f788..edb3968c 100644 --- a/source/xuperos/xuperos_go.rst +++ b/source/xuperos/xuperos_go.rst @@ -204,4 +204,4 @@ Go SDK 使用配置文件有两种方式： fmt.Printf("%s", tx.ContractResponse) } -具体接口文档参考 `Go SDK 使用文档 <../development_manuals/xuper-sdk-go.html>`_ 。 +具体接口文档参考 `Go SDK 使用文档 <../development_manuals/xuper-sdk/xuper-sdk-go.html>`_ 。 diff --git a/source/xuperos/xuperos_java.rst b/source/xuperos/xuperos_java.rst index 1635adfe..3144e755 100644 --- a/source/xuperos/xuperos_java.rst +++ b/source/xuperos/xuperos_java.rst @@ -131,4 +131,4 @@ Java SDK 接入指南 System.out.println(tx.getContractResponse().getBodyStr()); -具体接口文档参考 `Java SDK 使用文档 <../development_manuals/xuper-sdk-java.html>`_ 。 +具体接口文档参考 `Java SDK 使用文档 <../development_manuals/xuper-sdk/xuper-sdk-java.html>>`_ 。 diff --git a/source/xuperos/xuperos_js.rst b/source/xuperos/xuperos_js.rst index 2919636e..5480f7c9 100644 --- a/source/xuperos/xuperos_js.rst +++ b/source/xuperos/xuperos_js.rst @@ -215,4 +215,4 @@ JS SDK 连接开放网络与 Go SDK 有些许不同之处，主要在配置文 start() -具体接口文档参考 `JS SDK 使用文档 <../development_manuals/xuper-sdk-js.html>`_ 。 +具体接口文档参考 `JS SDK 使用文档 <../development_manuals/xuper-sdk/xuper-sdk-js.html>`_ 。 From 8c238f8583b5655e6cf9d1df564cbe2eb06b428a Mon Sep 17 00:00:00 2001 From: litian Date: Mon, 27 Feb 2023 15:22:48 +0800 Subject: [PATCH 3/5] Update tdpos.rst (#266) fix goverToken link --- source/design_documents/consensus/tdpos.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/design_documents/consensus/tdpos.rst b/source/design_documents/consensus/tdpos.rst index 2757228c..bc1b5d83 100644 --- a/source/design_documents/consensus/tdpos.rst +++ b/source/design_documents/consensus/tdpos.rst @@ -71,7 +71,7 @@ TDPoS类共识矿工轮转通过时间片来划分，当验证人确定之后， 节点想要参与竞选，需要先被提名到候选人池，只有被提名的地址才能接受投票。系统中所有拥有 **治理Token** 的节点均可参与提名和投票。为了收敛候选人集合，并一定程度上增加候选人参与的门槛，提名为候选人会有很多规则，主要有以下几点： -- 提名候选人需要治理Token，详见 `治理Token <<../../advanced_usage/governance.html#token>>`_ 。 +- 提名候选人需要治理Token，详见 `治理Token <../../advanced_usage/governance.html#token>`_ 。 - 该治理Token会被一直冻结，直到节点退出候选池。 From f5da12dfff99ae1d4f3993e98bc26fcdc7a7082d Mon Sep 17 00:00:00 2001 From: litian Date: Fri, 3 Mar 2023 11:13:31 +0800 Subject: [PATCH 4/5] Update multi_nodes.rst --- source/advanced_usage/multi_nodes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/advanced_usage/multi_nodes.rst b/source/advanced_usage/multi_nodes.rst index 58518f9f..628f7b3a 100644 --- a/source/advanced_usage/multi_nodes.rst +++ b/source/advanced_usage/multi_nodes.rst @@ -197,7 +197,7 @@ # KeyPath is the netdisk private key path keyPath: netkeys # BootNodes config the bootNodes the node to connect - # BootNodes 也可以选择都链接同一个节点，再启动网络时需要先启动该节点 + # BootNodes 也可以选择都链接同一个节点，在启动网络时需要先启动该节点 bootNodes: - "/ip4/127.0.0.1/tcp/47101/p2p/Qmf2HeHe4sspGkfRCTq6257Vm3UHzvh2TeQJHHvHzzuFw6" - "/ip4/127.0.0.1/tcp/47102/p2p/QmQKp8pLWSgV4JiGjuULKV1JsdpxUtnDEUMP8sGaaUbwVL" From 98abb6c7ff9d2a18e9b42d4a5319df21c7ee49b1 Mon Sep 17 00:00:00 2001 From: litian Date: Fri, 3 Mar 2023 11:14:31 +0800 Subject: [PATCH 5/5] Update conf.py --- source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/conf.py b/source/conf.py index 3b14ccbe..b3fcd669 100644 --- a/source/conf.py +++ b/source/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- project = u'XuperChain 官方文档' -copyright = u'2022, xuper' +copyright = u'2023, xuper' author = u'xuper' # The short X.Y version