From 6c78c5bc250a8a7029f6adb96a8ff9cd7cb185ef Mon Sep 17 00:00:00 2001 From: Benjamin Canou Date: Fri, 6 Jul 2018 14:45:35 +0200 Subject: [PATCH] Update README with new doc address and license --- README.md | 13 ++++++++----- docs/README.rst | 2 +- docs/conf.py | 8 +++++--- docs/index.rst | 13 +++++++++---- 4 files changed, 23 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c7ab52229..bcfebbb03 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,19 @@ capability. Tezos not only comes to consensus about the state of its ledger, like Bitcoin or Ethereum. It also attempts to come to consensus about how the protocol and the nodes should adapt and upgrade. - - Developer documentation is available online at http://doc.tzalpha.net + - Developer documentation is available online at http://tezos.gitlab.io/master + always in sync with the master branch (which may be desynchronized with + the code running on the live networks, replace `master` in the URL by the + branch of your choice: betanet, alphanet, zeronet, to make sure you are + consulting the right API version) - The page https://www.tezos.com/ contains more information about the project, even though it is frozen in time due to external reasons - All development now happens on Gitlab at https://gitlab.com/tezos/tezos The Tezos Alpha (test) network has been live and open since February 2017. - - More information on joining the Alphanet at http://doc.tzalpha.net/introduction/alphanet.html +The Tezos Beta (experimental) network has been live and open since June 2018. + - Several community built block explorers are available: - https://ostez.com - https://tzscan.io @@ -26,6 +31,4 @@ The Tezos Alpha (test) network has been live and open since February 2017. - There is a *#tezos* channel on *freenode* that is reserved for technical discussions - There is also a community FAQ at https://github.com/tezoscommunity/faq -The source code of Tezos is currently under exclusive copyright of -Dynamic Ledger Solutions, and will be open sourced under the MIT -license when the main network lunches. +The source code of Tezos is placed under the MIT Open Source License. diff --git a/docs/README.rst b/docs/README.rst index 04a29eda3..8c1463d42 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -2,7 +2,7 @@ Building documentation locally ****************************** -The documentation is available online at `doc.tzalpha.net `_, +The documentation is available online at `tezos.gitlab.io `_, always up to date with master on `GitLab `_. Building instructions diff --git a/docs/conf.py b/docs/conf.py index 08f1ea77b..433f97e3a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,6 +21,8 @@ import os import sys +import datetime +from os import environ sys.path.insert(0, os.path.abspath('.') + '/_extensions') # -- General configuration ------------------------------------------------ @@ -56,10 +58,10 @@ author = 'Dynamic Ledger Solutions, Inc. ' # built documents. # # The short X.Y version. -version = '0.0.1' -# The full version, including alpha/beta/rc tags. -release = '0.0.1' +version = os.environ.get('CI_COMMIT_REF_NAME', 'local') +# The full version, including alpha/beta/rc tags. +release = '(' + version + ' branch, ' + datetime.datetime.now().strftime(" %Y/%m/%d %H:%M)") # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # diff --git a/docs/index.rst b/docs/index.rst index 38c828a10..bd8a676ac 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,13 +12,20 @@ capability. Tezos not only comes to consensus about the state of its ledger, like Bitcoin or Ethereum. It also attempts to come to consensus about how the protocol and the nodes should adapt and upgrade. - - Developer documentation is available online at http://doc.tzalpha.net + - Developer documentation is available online at http://tezos.gitlab.io/master + always in sync with the master branch (which may be desynchronized with + the code running on the live networks, replace ``master`` in the URL by the + branch of your choice: betanet, alphanet, zeronet, to make sure you are + consulting the right API version) - The official Tezos website https://tezos.com/ contains more information about the project. - All development now happens on GitLab at https://gitlab.com/tezos/tezos The Tezos Alpha (test) network has been live and open since February 2017. +The Tezos Beta (experimental) network has been live and open since June 2018. + + - More information on joining the Alphanet at :ref:`here `. - Several community built block explorers are available: @@ -36,9 +43,7 @@ The Tezos Alpha (test) network has been live and open since February 2017. - There is a *#tezos* channel on *freenode* that is reserved for technical discussions - There is also a community FAQ at https://github.com/tezoscommunity/faq/wiki/Tezos-Technical-FAQ -The source code of Tezos is currently under exclusive copyright of -Dynamic Ledger Solutions, and will be open sourced under the MIT -license when the main network lunches. +The source code of Tezos is placed under the MIT Open Source License. .. toctree:: :maxdepth: 2