Merge pull request #454 from threefoldtech/development

dev to master periodic update

scripts/calculate_marketcap.sh

@@ -9,10 +9,10 @@ url="https://api.coingecko.com/api/v3/simple/price?ids=${coinId}&vs_currencies=u
 curl -sL ${url} \
 -H 'Accept: application/json' | jq '."threefold-token".usd' | xargs printf "%.3f" > tft_value.md
 
-liquidity=$(cat tft_liquidity.md)
+supply=$(cat tft_supply.md)
 
 value=$(cat tft_value.md)
 
-TFT_MARKETCAP=$(echo "$liquidity * $value" | bc -l)
+TFT_MARKETCAP=$(echo "$supply * $value" | bc -l)
 
 printf "%'.0f" $TFT_MARKETCAP > tft_marketcap.md

src/SUMMARY.md

@@ -159,9 +159,6 @@
       - [4. Wipe All the Disks](documentation/farmers/3node_building/4_wipe_all_disks.md)
       - [5. Set the BIOS/UEFI](documentation/farmers/3node_building/5_set_bios_uefi.md)
       - [6. Boot the 3Node](documentation/farmers/3node_building/6_boot_3node.md)
-    - [Complete DIY 3Node Guides](documentation/farmers/complete_diy_guides/complete_diy_guides_readme.md)
-      - [3Node Desktop DIY Guide](documentation/farmers/complete_diy_guides/3node_diy_desktop/3node_diy_desktop.md)
-      - [3Node Rack Server DIY Guide](documentation/farmers/complete_diy_guides/3node_diy_rack_server/3node_diy_rack_server.md)
     - [Farming Optimization](documentation/farmers/farming_optimization/farming_optimization.md)
       - [GPU Farming](documentation/farmers/3node_building/gpu_farming.md)
       - [Set Additional Fees](documentation/farmers/farming_optimization/set_additional_fees.md)

src/documentation/farmers/3node_building/1_create_farm.md

@@ -3,21 +3,86 @@
 <h2> Table of Contents </h2>
 
 - [Introduction](#introduction)
-- [Using Dashboard](#using-dashboard)
-- [Using TF Connect App](#using-tf-connect-app)
+- [Create a TFChain Account](#create-a-tfchain-account)
+- [Create a Farm](#create-a-farm)
+- [Create a ThreeFold Connect Wallet](#create-a-threefold-connect-wallet)
+- [Add a Stellar Address for Payout](#add-a-stellar-address-for-payout)
+  - [Farming Rewards Distribution](#farming-rewards-distribution)
+- [More Information](#more-information)
 
 ***
 
 ## Introduction
 
-You can create a farm with either the ThreeFold Dashboard or the ThreeFold Connect app.
+We cover the basic steps to create a farm with the ThreeFold Dashboard. We also create a TFConnect app wallet to receive the farming rewards. 
 
-## Using Dashboard
+## Create a TFChain Account
 
-The Dashboard section contains all the information required to [create a farm](../../dashboard/farms/your_farms.md).
+We create a TFChain account using the ThreeFold Dashboard.
 
-![dashboard_bootstrap_farm](./img/dashboard_bootstrap_farm.png)
+Go to the [ThreeFold Dashboard](https://dashboard.grid.tf/), click on **Create Account**, choose a password and click **Connect**.
 
-## Using TF Connect App
+![tfchain_create_account](./img/dashboard_tfchain_create_account.png)
 
-You can [create a ThreeFold farm](../../threefold_token/storing_tft/tf_connect_app.md) with the ThreeFold Connect App.
+Once your profile gets activated, you should find your Twin ID and Address generated under your Mnemonics for verification. Also, your Account Balance will be available at the top right corner under your profile name.
+
+![tf_mnemonics](./img/dashboard_tf_mnemonics.png)
+
+## Create a Farm
+
+We create a farm using the dashboard.
+
+In the left-side menu, select **Farms** -> **Your Farms**.
+
+![your_farms](./img/dashboard_your_farms.png)
+
+Click on **Create Farm**, choose a farm name and then click **Create**.
+
+![create_farm](./img/dashboard_create_farm.png)
+
+![farm_name](./img/dashboard_farm_name.png)
+
+## Create a ThreeFold Connect Wallet
+
+Your farming rewards should be sent to a Stellar wallet with a TFT trustline enabled. The simplest way to proceed is to create a TF Connect app wallet as the TFT trustline is enabled by default on this wallet. For more information on TF Connect, read [this section](../../threefold_token/storing_tft/tf_connect_app.md).
+
+Let's create a TFConnect Wallet and take note of the wallet address. First, download the app.
+
+This app is available for [Android](https://play.google.com/store/apps/details?id=org.jimber.threebotlogin&hl=en&gl=US) and [iOS](https://apps.apple.com/us/app/threefold-connect/id1459845885).
+
+- Note that for Android phones, you need at minimum Android Nougat, the 8.0 software version.
+- Note that for iOS phones, you need at minimum iOS 14.5. It will be soon available to iOS 13.
+
+Open the app, click **SIGN UP**, choose a ThreeFold Connect Id, write your email address, take note of the seed phrase and choose a pin. Once this is done, you will have to verify your email address. Check your email inbox.
+
+In the app menu, click on **Wallet** and then click on **Create Initial Wallet**.
+
+To find your wallet address, click on the **circled i** icon at the bottom of the screen.
+
+![dashboard_tfconnect_wallet_1](./img/dashboard_tfconnect_wallet_1.png)
+
+Click on the button next to your Stellar address to copy the address.
+
+![dashboard_tfconnect_wallet_2](./img/dashboard_tfconnect_wallet_2.png)
+
+You will need the TF Connect wallet address for the next section.
+
+> Note: Make sure to keep your TF Connect Id and seed phrase in a secure place offline. You will need these two components to recover your account if you lose access.
+
+## Add a Stellar Address for Payout
+
+In the **Your Farms** section of the dashboard, click on **Add/Edit Stellar Payout Address**.
+
+![dashboard_walletaddress_1](./img/dashboard_walletaddress_1.png)
+
+Paste your Stellar wallet address and click **Submit**.
+
+![dashboard_walletaddress_2](./img/dashboard_walletaddress_2.png)
+
+### Farming Rewards Distribution
+
+Farming rewards will be sent to your farming wallet around the 8th of each month. This can vary depending on the situation. The minting is done automatically by code and verified by humans as a double check.
+
+## More Information
+
+For more information, such as setting IP addresses, you can consult the [Dashboard Farms section](../../dashboard/farms/farms.md).

src/documentation/farmers/3node_building/2_bootstrap_image.md

@@ -7,12 +7,16 @@
 - [Burn the Zero-OS Bootstrap Image](#burn-the-zero-os-bootstrap-image)
   - [CD/DVD BIOS](#cddvd-bios)
   - [USB Key BIOS+UEFI](#usb-key-biosuefi)
-- [Expert Mode](#expert-mode)
-  - [Use a Specific Kernel](#use-a-specific-kernel)
-  - [Disable GPU](#disable-gpu)
-- [Bootstrap Image URL](#bootstrap-image-url)
-  - [Zeros-OS Bootstrapping](#zeros-os-bootstrapping)
-  - [Zeros-OS Expert Bootstrap](#zeros-os-expert-bootstrap)
+    - [BalenaEtcher (MAC, Linux, Windows)](#balenaetcher-mac-linux-windows)
+    - [CLI (Linux)](#cli-linux)
+    - [Rufus (Windows)](#rufus-windows)
+- [Additional Information (Optional)](#additional-information-optional)
+  - [Expert Mode](#expert-mode)
+    - [Use a Specific Kernel](#use-a-specific-kernel)
+    - [Disable GPU](#disable-gpu)
+  - [Bootstrap Image URL](#bootstrap-image-url)
+    - [Zeros-OS Bootstrapping](#zeros-os-bootstrapping)
+    - [Zeros-OS Expert Bootstrap](#zeros-os-expert-bootstrap)
 
 ***
 
@@ -56,16 +60,23 @@ Download the bootstrap image. Next, we will burn the bootstrap image.
 
 ## Burn the Zero-OS Bootstrap Image
 
+We show how to burn the Zero-OS bootstrap image. A quick and modern way is to burn the bootstrap image on a USB key.
+
 ### CD/DVD BIOS 
 
 For the BIOS **ISO** image, download the file and burn it on a DVD.
 
-
 ### USB Key BIOS+UEFI
 
+There are many ways to burn the bootstrap image on a USB key. The easiest way that works for all operating systems is to use BalenaEtcher. We also provide other methods.
+
+#### BalenaEtcher (MAC, Linux, Windows)
+
 For **MAC**, **Linux** and **Windows**, you can use [BalenaEtcher](https://www.balena.io/etcher/) to load/flash the image on a USB stick. This program also formats the USB in the process. This will work for the option **EFI IMG** for UEFI boot, and with the option **USB** for BIOS boot. Simply follow the steps presented to you and make sure you select the bootstrap image file you downloaded previously.
 
-General Steps:
+> Note: There are alternatives to BalenaEtcher (e.g. [usbimager](https://gitlab.com/bztsrc/usbimager/)).
+
+**General Steps with BalenaEtcher:**
 
 1. Download BalenaEtcher
 2. Open BalenaEtcher
@@ -77,32 +88,37 @@ General Steps:
 That's it. Now you have a bootstrap image on Zero-OS as a bootable removable media device.
 
 
-For the BIOS **USB** and the UEFI **EFI IMG** images, with Linux, you will want to do:
+#### CLI (Linux)
+
+For the BIOS **USB** and the UEFI **EFI IMG** images, you can do the following on Linux:
 
-    sudo dd status=progress if=FILELOCATION.ISO(or .IMG) of=/dev/sd*.
+    sudo dd status=progress if=FILELOCATION.ISO(or .IMG) of=/dev/sd*
 
 Here the * is to indicate that you must adjust according to your disk. To see your disks, write lsblk in the command window. Make sure you select the proper disk!
 
 *If you USB key is not new, make sure that you format it before burning the Zero-OS image.
 
+#### Rufus (Windows)
 
-For Windows, if you are using the "dd" able image, instead of writing command line, you can use the free USB flashing program called [Rufus](https://sourceforge.net/projects/rufus.mirror/) and it will automatically do this with no need for Linux or command line. Rufus also formats the boot media in the process.
+For Windows, if you are using the "dd" able image, instead of writing command line, you can use the free USB flashing program called [Rufus](https://sourceforge.net/projects/rufus.mirror/) and it will automatically do this without needing to use the command line. Rufus also formats the boot media in the process.
 
+## Additional Information (Optional)
 
+We cover some additional information. Note that the following information is not needed for a basic farm setup.
 
-## Expert Mode
+### Expert Mode
 
 You can use the [expert mode](https://v3.bootstrap.grid.tf/expert) to generate specific Zero-OS bootstrap images.
 
 Along the basic options of the normal bootstrap mode, the expert mode allows farmers to add extra kernel arguments and decide which kernel to use from a vast list of Zero-OS kernels.
 
-### Use a Specific Kernel
+#### Use a Specific Kernel
 
 You can use the expert mode to choose a specific kernel. Simply set the information you normally use and then select the proper kernel you need in the **Kernel** drop-down list.
 
 ![](./img/bootstrap_kernel_list.png)
 
-### Disable GPU
+#### Disable GPU
 
 You can use the expert mode to disable GPU on your 3Node.
 
@@ -125,7 +141,7 @@ In the expert mode of the Zero-OS Bootstrap generator, fill in the following inf
 - Click on **Generate**
 - Click on **Download**
 
-## Bootstrap Image URL
+### Bootstrap Image URL
 
 In both normal and expert mode, you can use the generated URL to quickly download a Zero-OS bootstrap image based on your farm specific setup. 
 
@@ -139,7 +155,7 @@ Note that the arguments and the kernel are optional.
 
 The following content will provide some examples.
 
-### Zeros-OS Bootstrapping
+#### Zeros-OS Bootstrapping
 
 On the [main page](https://v3.bootstrap.grid.tf/), once you've written your farm ID and selected a network, you can copy the generated URL of any given image format.
 
@@ -149,7 +165,7 @@ For example, the following URL is a download link to an **EFI IMG** of the Zero-
 https://v3.bootstrap.grid.tf/uefimg/prod/1
 ```
 
-### Zeros-OS Expert Bootstrap
+#### Zeros-OS Expert Bootstrap
 
 You can use the generated sublink at the **Generate step** of the expert mode to get a quick URL to download your bootstrap image.