Doc: update howto, alphanet, zeronet pages

docs/index.rst

@@ -49,10 +49,10 @@ license when the main network lunches.
 
 .. toctree::
    :maxdepth: 2
-   :caption: The Alphanet:
+   :caption: Test Networks:
 
+   introduction/faucet
    introduction/alphanet
-   introduction/alphanet_changes
    introduction/zeronet
 
 .. toctree::

docs/introduction/alphanet.rst

@@ -1,7 +1,7 @@
 .. _alphanet:
 
-Participating in the Alphanet
+Alphanet
-=============================
+========
 
 Welcome to the Tezos alphanet, which is a pre-release network for the
 Tezos blockchain. Currently, the chain is reset every few weeks.
@@ -81,32 +81,10 @@ set an environment variable:
 Compilation from sources
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-The ``alphanet`` branch in the tezos git repository will always contain
+Please refer to the :ref:`instructions<howto>`.
-the up-to-date sources of the tezos-node required for running the
-alphanet. See ``docs/README.master`` on how to compile it.
 
-Once built, you might launch a node by running:
+For the rest of the document, to execute the example commands, you
-
+will have to replace ``./alphanet.sh client`` by ``./tezos-client``.
-::
-
-    ./tezos-node identity generate 24.
-    ./tezos-node run --rpc-addr localhost
-
-By default this instance will store its data in ``$HOME/.tezos-node``
-and will listen to incoming peers on port 9732. It will also listen to
-RPC requests on port 8732 (only from ``localhost``). You might find more
-options by running ``./tezos-node config --help``.
-
-If you want to stake (see below for more details), you will also have to
-run:
-
-::
-
-    ./tezos-client launch daemon
-
-That’s all. For the rest of the document, to execute the example
-commands, you will have to replace ``./alphanet.sh client`` by
-``./tezos-client``.
 
 How to observe the network ?
 ----------------------------
@@ -124,47 +102,10 @@ In an upcoming version, we will also provide an opt-in tool for node
 runners that will allow us to provide a global monitoring panel of the
 alphanet.
 
-How to obtain free Tez from the faucet contract ?
+How to obtain free Tezzies
--------------------------------------------------
+--------------------------
 
-The alphanet contains an ad-hoc faucet contract, that will generate new
+See :ref:`this page<faucet>`.
-tezzies for you to test. Obviously, this contract will not be available
-outside of the test network.
-
-First, if you don’t have any cryptographic identity yet, you need to
-generate one (replace ``my_identity`` with any name that suits you
-best):
-
-::
-
-    ./alphanet.sh client gen keys "my_identity"
-
-Then, you have to generate a new “free” account (replace ``my_account``
-with any name that suits you best and ``my_identity`` by the name used
-in the previous command):
-
-::
-
-    ./alphanet.sh client originate free account "my_account" for "my_identity"
-
-That’s all. You might check your balance:
-
-::
-
-    ./alphanet.sh client get balance for "my_account"
-
-If you want MORE tezzies, you need to generate as many free accounts as
-you need (you should receive ꜩ100.000 per account) and then transfer the
-tezzies into a single account. For instance:
-
-::
-
-    ./alphanet.sh client originate free account "my_alt_account" for "my_identity"
-    ./alphanet.sh client transfer 100,000.00 from "my_alt_account" to "my_account" -fee 0.00
-    ./alphanet.sh client forget contract "my_alt_account"
-
-Note that the test network is kind enough to accept transactions without
-fees…
 
 How to play with smart-contracts ?
 ----------------------------------
@@ -179,7 +120,7 @@ Some test contracts are in
 
 For details and examples, see:
 
-http://www.michelson-lang.com/
+https://www.michelson-lang.com/
 
 How to stake on the alphanet ?
 ------------------------------
@@ -308,3 +249,5 @@ and regenerate a new one:
 
     ./alphanet.sh client forget contract "my_account"
     ./alphanet.sh client originate free account "my_account" for "my_identity"
+
+.. include:: alphanet_changes.rst

docs/introduction/alphanet_changes.rst

@@ -1,8 +1,8 @@
-Alphanet changelog
+Changelog
-==================
+---------
 
 For the next reset
-------------------
+~~~~~~~~~~~~~~~~~~
 
 [Alpha]
 
@@ -37,7 +37,7 @@ For the next reset
 
 
 Reset 2017-11-20
-------------------
+~~~~~~~~~~~~~~~~
 
 [Alphanet]
 
@@ -107,7 +107,7 @@ Reset 2017-11-20
 - Add `SIZE` on lists.
 
 Reset 2017-11-17
-----------------
+~~~~~~~~~~~~~~~~
 
 [Node]
 
@@ -115,7 +115,7 @@ Reset 2017-11-17
 - Irmin: restore usage `git-repack`... (mistakenly removed)
 
 Reset 2017-10-13
-----------------
+~~~~~~~~~~~~~~~~
 
 [Client]
 
@@ -137,7 +137,7 @@ Reset 2017-10-13
    prevent an error raised when using an unrevealed key.
 
 Reset 2017-09-21
-----------------
+~~~~~~~~~~~~~~~~
 
 [Node]
 
@@ -159,7 +159,7 @@ Reset 2017-09-21
    prevent an error raised when using an unrevealed key.
 
 Reset 2017-08-10
-----------------
+~~~~~~~~~~~~~~~~
 
 This update includes changes in the on-disk state of the node and in
 the format of blocks and operations. It thus requires a chain reset.
@@ -194,7 +194,7 @@ Main changes includes:
 - minor language enhancements, mostly resulting from the feedback of
   Milo's daily challenge:
 
-    http://www.michelson-lang.com/
+    https://www.michelson-lang.com/
 
 - the alphanet scripts now understands a container: prefix wherever a
   file: prefix is accepted, temporarily copying the file into the

docs/introduction/faucet.rst

@@ -0,0 +1,38 @@
+.. _faucet:
+
+Get testnet coins
+=================
+
+If you wish to play with the Alphanet or the Zeronet, you must first
+grab a wallet from the faucet:
+
+https://faucet.tzalpha.net/
+
+This will provide you with a JSON file, named like
+``tz1__xxxxxxxxx__.json``.  Once your node is synchronized, you should
+run the following command to activate your wallet, where ``my_account``
+is a local name you choose, and ``tz1__xxxxxxxxx__.json`` is the name
+of the file you grab:
+
+::
+
+    $ tezos-client activate account my_account with tz1__xxxxxxxxx__.json
+    Operation successfully injected in the node.
+    Operation hash is 'ooGoVS5cikbTHEimTzYhQWrYqY2LeJYmfkbzoiW8KQ59jtGQaXr'.
+    Waiting for the operation to be included...
+    Operation found in block: BKihN2QgSAu2etftNvs8FWWhwTvZiY8P3e7H3jgdj2MCpKZXXRs
+    Account my_account (tz1__xxxxxxxxx__) created with ꜩ23,454.
+
+Or, if you use the ``alphanet.sh`` (resp. ``zeronet.sh``) script, you
+should prefix the file with ``container:`` in order to copy it into
+the docker image:
+
+::
+
+    $ ./alphanet.sh client activate account my_account with container:tz1__xxxxxxxxx__.json
+
+Please preserve the JSON file, after each reset of the Alphanet (or
+Zeronet), you will have to reactivate the wallet.
+
+Please drink carefully and don't abuse the faucet: it only contains
+30.000 wallets for a total amount of ꜩ760.000.000.

docs/introduction/howto.rst

@@ -1,3 +1,5 @@
+.. _howto:
+
 How to build and run
 ====================
 
@@ -13,8 +15,8 @@ You also need to **choose a branch**:
 
 - The *master* branch is where code is merged, but there is no test
   network using the *master* branch directly.
-- The *zeronet* and *zeronet-lmdb* is what you want to use if you want
+- The *alphanet* and *alphanet-lmdb* is what you want to use if you want
-  to connect to the most cutting-edge test network, the *Zeronet*. The
+  to connect to Tezos' test network, the *Alphanet*. The
   *-lmdb* version uses LMDB instead of LevelDB.
 
 **TL;DR**: Typically you want to do:
@@ -22,7 +24,7 @@ You also need to **choose a branch**:
 ::
 
    git clone git@gitlab.com:tezos/tezos.git
-   git checkout zeronet
+   git checkout alphanet
 
 Install OPAM
 ------------
@@ -117,12 +119,12 @@ opam internal state with the following commands:
     make
 
 
-Join the Zeronet!
+Join the Alphanet!
------------------
+------------------
 
-If you succesfully built Tezos on the *zeronet* or *zeronet-lmdb*
+If you succesfully built Tezos on the *alphanet* or *alphanet-lmdb*
 branch, then your node is elligible to join Tezos'
-:ref:`Zeronet<zeronet>`.
+:ref:`Alphanet<alphanet>`.
 
 Command-line basics
 ~~~~~~~~~~~~~~~~~~~
@@ -149,7 +151,7 @@ them.
 Configure your node
 ~~~~~~~~~~~~~~~~~~~
 
-The following steps are required to connect to Zeronet.
+The following steps are required to connect to Alphanet.
 
 ::
 
@@ -170,7 +172,7 @@ The identity will be stored in `$HOME/.tezos-node/identity.json`.
 This will initialize an configuration file for the node in
 `$HOME/.tezos-node/config.json`, using default values. It only
 specifies that the node will listen to incoming connections on socket
-address ``[::]:19732``.
+address ``[::]:9732``.
 
 The easiest way to amend this default configuration is to use
 
@@ -217,7 +219,7 @@ To interact with your node, read the doc of clients:
    ./tezos-admin-client man
    ./tezos-alpha-baker man
 
-And read :ref:`this page<zeronet>` to get zeronet tezzies.
+And read :ref:`this page<alphanet>` to get alphanet tezzies.
 
 Run the node in a sandbox
 -------------------------

docs/introduction/zeronet.rst

@@ -1,45 +1,13 @@
 .. _zeronet:
 
-The zeronet network
+Zeronet
-===================
+=======
 
-The Tezos zeronet is a development network that might be broken multiple
+Zeronet is the most cutting-edge development network of Tezos. It is
-times a day.
+restarted without notice, possibly several times a day.
 
-If you wish to experiment with Tezos we recommend you to test the
+If you wish to experiment with Tezos we recommend you to test
-``alphanet``, which is a more stable test network.
+:ref:`Alphanet<alphanet>`, which is a more stable test network. We
+offer no support about the zeronet.
 
-In particular, we offer no support about the zeronet.
+To get free zeronet coins, read :ref:`this page <faucet>`.
-
-If you wish to play with the zeronet, you must first grab a wallet
-from the faucet:
-
-https://faucet.tzalpha.net/
-
-This will provide you with a JSON file, named like
-``tz1__xxxxxxxxx__.json``.  Once your node is synchronized, you should
-run the following command to activate your wallet, where ``my_account``
-is a local name you choose, and ``tz1__xxxxxxxxx__.json`` is the name
-of the file you grab:
-
-::
-
-    $ tezos-client activate account my_account with tz1__xxxxxxxxx__.json
-    Operation successfully injected in the node.
-    Operation hash is 'ooGoVS5cikbTHEimTzYhQWrYqY2LeJYmfkbzoiW8KQ59jtGQaXr'.
-    Waiting for the operation to be included...
-    Operation found in block: BKihN2QgSAu2etftNvs8FWWhwTvZiY8P3e7H3jgdj2MCpKZXXRs
-    Account my_account (tz1__xxxxxxxxx__) created with ꜩ23,454.
-
-Or, if you use the ``zeronet.sh`` script, you should prefix the file
-with ``container:`` in order to copy it into the docker image:
-
-::
-
-    $ ./zeronet.sh client activate account my_account with container:tz1__xxxxxxxxx__.json
-
-Please preserve the JSON file, after each reset of the zeronet, you
-will have to reactivate the wallet.
-
-Please drink carefully and don't abuse the faucet: it only contains
-30.000 wallets for a total amount of ꜩ760.000.000.