From af53ca988fbcc0831df7598ce9f87dc2d22a65a6 Mon Sep 17 00:00:00 2001 From: wwwjim Date: Wed, 4 Dec 2019 09:53:36 -0800 Subject: [PATCH] documentation: revisions --- documentation/en/getting-started.md | 3 +-- documentation/en/hardware.md | 2 ++ documentation/en/join-devnet-cli.md | 4 ++-- documentation/en/mining.md | 4 ++-- documentation/en/retrieving-data.md | 2 +- documentation/en/setting-a-static-port.md | 10 +++++----- documentation/en/storing-data.md | 4 ---- 7 files changed, 13 insertions(+), 16 deletions(-) diff --git a/documentation/en/getting-started.md b/documentation/en/getting-started.md index db8f2ebf7..1ba92daed 100644 --- a/documentation/en/getting-started.md +++ b/documentation/en/getting-started.md @@ -7,9 +7,8 @@ For more details about Filecoin, check out the [Filecoin Spec](https://github.co ## What can I learn here? - How to install Lotus on [Arch Linux](https://docs.lotu.sh/install-lotus-arch), [Ubuntu](https://docs.lotu.sh/install-lotus-ubuntu), or [MacOS](https://docs.lotu.sh/install-lotus-macos). -- [Storing](https://docs.lotu.sh/storing-data) or [retrieving](https://docs.lotu.sh/retrieving-data) data. - Joining the **Lotus DevNet** using your [CLI](https://docs.lotu.sh/join-devnet-cli). -- Test Lotus in a seperate local network using [Pond UI](https://docs.lotu.sh/testing-with-gui). +- [Storing](https://docs.lotu.sh/storing-data) or [retrieving](https://docs.lotu.sh/retrieving-data) data. - Mining Filecoin using the **Lotus Storage Miner** in your [CLI](https://docs.lotu.sh/mining). ## What makes Lotus different? diff --git a/documentation/en/hardware.md b/documentation/en/hardware.md index 1648ede95..6ea454852 100644 --- a/documentation/en/hardware.md +++ b/documentation/en/hardware.md @@ -1,5 +1,7 @@ # Hardware +> This page is a work in progress. Exact mining requirements are still in the works. + Lotus can build and run on most [Linux](https://ubuntu.com/) and [MacOS](https://www.apple.com/macos) systems with at least 8GB of RAM. Windows is not yet supported. diff --git a/documentation/en/join-devnet-cli.md b/documentation/en/join-devnet-cli.md index 3773682f8..461afaf6e 100644 --- a/documentation/en/join-devnet-cli.md +++ b/documentation/en/join-devnet-cli.md @@ -6,7 +6,7 @@ If you have run Lotus before and want to remove all previous data: `rm -rf ~/.lo ## Genesis & Bootstrap -The current Lotus build will automatically join the **Lotus DevNet** using the genesis and bootstrap files in the `build/` directory using a default configuration. +The current Lotus build will automatically join the **Lotus DevNet** using the genesis and bootstrap files in the `build/`. ## Start Daemon @@ -38,7 +38,7 @@ $ lotus wallet new bls t3... ``` -- Visit the [faucet](https://lotus-faucet.kittyhawk.wtf/) +- Visit the [faucet](https://lotus-faucet.kittyhawk.wtf/funds.html) - Paste the address you created - Press Send. diff --git a/documentation/en/mining.md b/documentation/en/mining.md index f2b095b5b..4f52172d8 100644 --- a/documentation/en/mining.md +++ b/documentation/en/mining.md @@ -55,9 +55,9 @@ $ lotus-storage-miner state sectors ## Assign a nickname for your node -In the `.lotus` folder, create a `config.toml` or modify an existing file with: +In the `.lotus` folder, modify `config.toml` with: -``` +```sh [Metrics] Nickname="snoopy" ``` diff --git a/documentation/en/retrieving-data.md b/documentation/en/retrieving-data.md index c7f9d18fd..a4c0d46f6 100644 --- a/documentation/en/retrieving-data.md +++ b/documentation/en/retrieving-data.md @@ -14,4 +14,4 @@ Retrieve data from a **Lotus Storage Miner**. $ lotus client retrieve ``` -This will initiate a **retrieval deal** and write the data to the outfile. This process may take some time. +This will initiate a **retrieval deal** and write the data to the outfile. This process may take 2 to 10 minutes. \ No newline at end of file diff --git a/documentation/en/setting-a-static-port.md b/documentation/en/setting-a-static-port.md index 06fefc4d5..d5b2d3c43 100644 --- a/documentation/en/setting-a-static-port.md +++ b/documentation/en/setting-a-static-port.md @@ -1,6 +1,6 @@ # Static port -If you plan to accept a **storage deal**, you will want to set a static port and open it in your firewall to ensure clients can connect to you. +For a **storage deal**, you may want to set a static port and open it in your firewall to ensure clients can connect to you. Lotus binds to a random **swarm port** by default. @@ -17,15 +17,15 @@ Here is an example of changing the port to `1347`. Once you update `config.toml`, restart your **daemon**. -## Open firewall on Ubuntu manually +## Ubuntu's Uncomplicated Firewall + +Open firewall manually ```sh # ufw allow 1347/tcp ``` -## Open firewall using a UFW profile - -Open and modify `/etc/ufw/applications.d/lotus-daemon` with: +Or open and modify the profile located at `/etc/ufw/applications.d/lotus-daemon` ```sh [Lotus Daemon] diff --git a/documentation/en/storing-data.md b/documentation/en/storing-data.md index e46deb2a4..54f891818 100644 --- a/documentation/en/storing-data.md +++ b/documentation/en/storing-data.md @@ -1,9 +1,5 @@ # Storing Data -You can store files that have the minimum file size of 256 bytes. - -## Tutorial - Start by creating a file, in this example we will use the command line to create `hello.txt`. ```sh