Merge #1901

1901: Changes in docs (ep5) r=damip a=Noxhaa



Co-authored-by: Noxha <[email protected]>

README.md

@@ -35,11 +35,11 @@ rules](docs/testnet_rules.md).
 
 ## Testnet Discussions
 
-Please come to our [Discord](https://discord.com/invite/TnsJQzXkRN) for
+Please come to our [Discord](https://discord.com/invite/massa) for
 testnet discussions, in the testnet channel.
 
 For project announcements, we mainly use
-[Telegram](https://t.me/massanetwork).
+[Telegram](https://t.me/massanetwork), and we also have a [Twitter](https://twitter.com/MassaLabs) account.
 
 ## Tutorials to follow to join the testnet
 
@@ -55,10 +55,10 @@ For project announcements, we mainly use
 -   [Updating the node](docs/update.md)
 -   [Sending transactions](docs/transaction.md)
 
-## FAQ and Troubleshooting
+## [FAQ](docs/faq.md) and Troubleshooting
 
 You'll find answers to common issues and questions regarding the Massa
 protocol in the [FAQ](docs/faq.md).
 
 Don't hesitate to ask questions in the
-[Discord](https://discord.com/invite/TnsJQzXkRN) testnet channel.
+[Discord](https://discord.com/invite/massa) testnet channel.

docs/faq.md

@@ -129,8 +129,8 @@ beginning of cycle C+3.
 
 For now, they don't stake automatically. In the future, we will add a
 feature allowing auto compounding. That being said, some people appear
-to have done that very early in the project. Feel free to ask on the
-link:https://discord.com/invite/TnsJQzXkRN\[Discord\] server :).
+to have done that very early in the project. Feel free to ask on the 
+[Discord](https://discord.com/invite/massa) server :).
 
 ### I can buy, send, sell ROLLs and coins without fees. When should I increase the fee \>0?
 
@@ -196,16 +196,17 @@ Check the quality of your internet connection. Try increasing the
     `could not start API controller: ServerError(hyper::Error(Listen, Os { code: 98, kind: AddrInUse, message: "Address already in use" }))`,
     it's probably because the default API ports 33034/33035 are already in use
     on your computer. You should change the port in the config files,
-    both in the API and Client: \*\* create/edit file
-    `massa-node/config/config.toml` to change the port used by the API:
+    both in the API and Client:
+
+  * create/edit file `massa-node/config/config.toml` to change the port used by the API:
 
 ```toml
 [api]
     bind_private = "127.0.0.1:33034"  # change port here from 33034 to something else
     bind_public = "0.0.0.0:33035"  # change port here from 33035 to something else
 ```
 
-\*\* create/edit file `massa-client/config/config.toml` and put the same
+  * create/edit file `massa-client/config/config.toml` and put the same
 port:
 
 ```toml

docs/install.md

@@ -4,7 +4,7 @@ Right now 4 cores and 8 GB of RAM should be enough to run a node, but it might i
 
 ## From binaries
 If you just wish to run a Massa node without compiling it yourself, you
-can simply run the latest binary (download and execute):
+can simply get the latest binary (download below and go the the next step: [Running a node](run.md))
 
 -   [Windows
     executable](https://gitlab.com/massalabs/massa/-/jobs/artifacts/testnet/download?job=build-windows)
@@ -30,7 +30,7 @@ Otherwise, if you wish to run a Massa node from source code, here are the steps
 -   set it as default: `rustup default nightly`
 -   check rust version: `rustc --version`
 -   clone this repo:
-    `git clone --branch testnet https://gitlab.com/massalabs/massa.git`
+    `git clone --branch testnet https://github.com/massalabs/massa.git`
 
 ### On Windows
 

docs/routability.md

@@ -54,11 +54,13 @@ operation to be made routable.
     address and port 31244 in
     <https://www.yougetsignal.com/tools/open-ports/> (then again with
     port 31245)
+-   Once your node is routable, you need to send the public IP address of your node to the Discord bot.
+    You first need to register to the staking reward program (see the last step below).
 
 ## Last step
 
 -   To validate your participation in the testnet staking reward program,
 you have to register with your Discord account. Write something in the
-`testnet-rewards` channel of our
-[Discord](https://discord.com/invite/TnsJQzXkRN) and our bot will DM you
+`testnet-rewards-registration` channel of our
+[Discord](https://discord.com/invite/massa) and our bot will DM you
 instructions. More info here: [Testnet rewards program](testnet_rules.md)

docs/run.md

@@ -1,8 +1,16 @@
 # Running a node
 
-## On Ubuntu / MacOS
+## From binaries
 
-### Start the node
+Simply run the binaries you downloaded in the previous step:
+    Open the `massa-node` folder and run the `massa-node` excutable
+    Open the `massa-client` folder and run the `massa-client` excutable
+
+## From source code
+
+### On Ubuntu / MacOS
+
+#### Start the node
 
 On a first window:
 
@@ -12,40 +20,43 @@ Launch the node, on Ubuntu:
 
     RUST_BACKTRACE=full cargo run --release |& tee logs.txt
 
-On macOS:
+**Or,** on macOS:
 
     RUST_BACKTRACE=full cargo run --release > logs.txt 2>&1
 
-### Start the client
+You should leave the window opened.
+
+#### Start the client
 
 On a second window:
 
     cd massa/massa-client/
+Then:
+
     cargo run --release
 
+Please wait until the directories are built before moving to the next step.
 
-## On Windows
+### On Windows
 
-### Start the Node
+#### Start the Node
 
 -   Open Windows Power Shell or Command Prompt on a first window
     -   Type: `cd massa`
     -   Type: `cd massa-node`
     -   Type: `cargo run --release`
 
-Your node is running. Once the process is finished, you should leave the
-window opened.
-
-You can now launch your client and move toward the wallet creation then
-the staking process.
+You should leave the window opened.
 
-### Start the Client
+#### Start the Client
 
 -   Open Windows Power Shell or Command Prompt on a second window
     -   Type: `cd massa`
     -   Type: `cd massa-client`
     -   Type: `cargo run --release`
 
+Please wait until the directories are built before moving to the next step.
+
 ## Next step
 
 -   [Creating a wallet](wallet.md)

docs/staking.md

@@ -2,7 +2,7 @@
 
 In Massa, the minimal number of coins required to be able to stake is
 100 MAS (which is called one "roll"). The total initial supply is 500m
-MAS, so in theory, there could be 1 million people staking.
+MAS, so in theory, there could be 5 million people staking.
 
 Addresses are randomly selected to stake (create blocks) in all threads,
 based on the number of rolls they possess. The list of stakers and their
@@ -11,7 +11,7 @@ rolls can be seen [there](https://test.massa.net/#staking).
 Rolls can be bought with Massa coins or sold to get the coins back. If
 you already have more than 100 Massa, you can continue this tutorial,
 otherwise, send your address to the faucet bot in the
-"testnet-faucet" channel of our [Discord](https://discord.com/invite/TnsJQzXkRN).
+"testnet-faucet" channel of our [Discord](https://discord.com/invite/massa).
 
 ## Buying rolls
 

docs/testnet_rules.md

@@ -27,18 +27,18 @@ therefore also reward how often your node is publicly accessible.
 
 ## Episodes
 
-We will have release cycles of 1 month each, called "episodes", the
-first one starting in August 2021. At the beginning of an episode,
-participants will have a few days to set up their nodes with the newest
+We have release cycles of 1 month each, called "episodes", the
+first one started in August 2021. At the beginning of an episode,
+participants have a few days to set up their nodes with the newest
 version before scoring starts, but it's also possible to join anytime
 during the episode.
 
 Throughout the episode, you can ask for coins in the Discord faucet (on
-channel testnet-token-request). No need to abuse the faucet, we don't
+channel `testnet-faucet`). No need to abuse the faucet, we don't
 reward you based on the number of rolls.
 
-At the end of the episode, all nodes will stop by themselves and become
-useless/unusable. Participants will have to download and launch the new
+At the end of an episode, all nodes stop by themselves and become
+useless/unusable. Participants have to download and launch the new
 version for the next episode. Make sure you keep the same node private
 key and wallet!
 
@@ -90,13 +90,13 @@ network health and will be a point of attention for rewards.
 
 To validate your participation in the testnet staking reward program,
 you have to register with your Discord account. Write something in the
-`testnet-rewards` channel of our
-[Discord](https://discord.com/invite/TnsJQzXkRN) and our bot will DM you
+`testnet-rewards-registration` channel of our
+[Discord](https://discord.com/invite/massa) and our bot will DM you
 instructions.
 
 ## From scores to rewards
 
-The launch of mainnet is currently planned for Q2 2022.
+The launch of mainnet is planned for mid-2022.
 
 By this time, people will be able to claim their rewards through a KYC
 process (most likely including video/liveness) to ensure that the same

docs/update.md

@@ -6,10 +6,14 @@ Update Rust:
 
     rustup update
 
-Update Massa:
+Make sure you you have the right git repository (especially since the change from GitLab to GitHub):
 
     cd massa/
     git stash
+    git remote set-url origin https://github.com/massalabs/massa.git
+
+Update Massa:
+
     git checkout testnet
     git pull
 

docs/wallet.md

@@ -13,6 +13,8 @@ Here is how to create a Massa wallet.
 
 ## From the command line interface
 
+### If your client is not running
+
 Go to the client folder:
 
 ```bash
@@ -28,13 +30,15 @@ cargo run
 It loads the wallet file `wallet.dat`. If it does not exist, it is
 created.
 
+### If your client is running
+
 Now you can either generate a new private key (and associated public key/address):
 
 ```plain
 wallet_generate_private_key
 ```
 
-or add manually an existing private key:
+**or**, add manually an existing private key if you already have one from a previous wallet:
 
 ```plain
 wallet_add_private_keys <your_private_key>
@@ -50,7 +54,7 @@ wallet_info
 
 If you don't plan to stake or use the command-line client, you can also
 create a wallet on the web interface: head to the
-[explorer](https://test.massa.net), in the wallet part.
+[explorer](https://test.massa.net), in the wallet tab.
 
 Click `Generate private key` then `Add`.