Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update v5.3branch (#254) #255

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion source/advanced_usage/multi_nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,14 +197,15 @@
# 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"
- "/ip4/127.0.0.1/tcp/47103/p2p/QmZXjZibcL5hy2Ttv5CnAQnssvnCbPEGBzqk7sAnL69R1E"
# service name
serviceName: localhost

.. note:: 注意: 如果您是部署在同一个节点上,p2p模块端口应该配置不同,同时不要和其他已经被占用的端口冲突
.. note:: 注意: 如果您是部署在同一个服务器上,p2p模块端口应该配置不同,同时不要和其他已经被占用的端口冲突


.. _net-start:
Expand Down
2 changes: 1 addition & 1 deletion source/advanced_usage/performance_introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
43 changes: 0 additions & 43 deletions source/advanced_usage/release.rst

This file was deleted.

11 changes: 5 additions & 6 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
# -- Project information -----------------------------------------------------

project = u'XuperChain 官方文档'
copyright = u'2021, xuper'
copyright = u'2023, 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 ---------------------------------------------------
Expand Down Expand Up @@ -137,7 +137,6 @@
# -- Options for manual page output ------------------------------------------



# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
Expand Down Expand Up @@ -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"
]
2 changes: 1 addition & 1 deletion source/design_documents/consensus/tdpos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ TDPoS类共识矿工轮转通过时间片来划分,当验证人确定之后,

节点想要参与竞选,需要先被提名到候选人池,只有被提名的地址才能接受投票。系统中所有拥有 **治理Token** 的节点均可参与提名和投票。为了收敛候选人集合,并一定程度上增加候选人参与的门槛,提名为候选人会有很多规则,主要有以下几点:

- 提名候选人需要治理Token,详见 `治理Token <../governance.html#xuperchain>`_ 。
- 提名候选人需要治理Token,详见 `治理Token <../../advanced_usage/governance.html#token>`_ 。

- 该治理Token会被一直冻结,直到节点退出候选池。

Expand Down
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,4 @@ XuperChain文档
more_materials/code_explanation.rst
more_materials/config_explanation.rst
more_materials/video.rst
more_materials/release.rst
18 changes: 18 additions & 0 deletions source/more_materials/release.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

下载发行版
========

最新版本
^^^^^^^^^^^^^^

v5.3
>>>>>>>>>>>>>>

* Linux: `xuperchain-linux-amd64-v5.3.zip <https://cms-store.bj.bcebos.com/xuperchain-linux-amd64-v5.3.zip>`_
* MacOS: `xuperchain-darwin-amd64-v5.3.zip <https://cms-store.bj.bcebos.com/xuperchain-darwin-amd64-v5.3.zip>`_


历史版本
^^^^^^^^^^^^^^

github: https://github.com/xuperchain/xuperchain/releases
4 changes: 2 additions & 2 deletions source/quickstart/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

XuperChain主要由Golang开发,需要首先准备编译运行的环境

- 安装go语言编译环境,推荐使用的版本为1.14或1.15
- 安装go语言编译环境,推荐使用的版本为 1.5 - 1.8(不包含)
- 下载地址:`golang <https://golang.org/dl/>`_
- 安装git
- 下载地址:`git <https://git-scm.com/download>`_
Expand All @@ -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 脚本
Expand Down
1 change: 1 addition & 0 deletions source/tree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,4 @@ XuperChain文档
more_materials/code_explanation.rst
more_materials/config_explanation.rst
more_materials/video.rst
more_materials/release.rst
2 changes: 1 addition & 1 deletion source/xuperos/xuperos_go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_ 。
2 changes: 1 addition & 1 deletion source/xuperos/xuperos_java.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>>`_ 。
2 changes: 1 addition & 1 deletion source/xuperos/xuperos_js.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_ 。