From 35ea6abe63d7cdeb05985f3aabd98eeb0024367c Mon Sep 17 00:00:00 2001 From: Rjan Date: Wed, 27 Apr 2022 14:17:07 +0200 Subject: [PATCH 1/5] Audit and revise get-started/overview Audit and revise the `get-started/overview` page. --- .../storage-providers/get-started/overview/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/storage-providers/get-started/overview/index.md b/content/en/storage-providers/get-started/overview/index.md index 8e442665..28aa7e50 100644 --- a/content/en/storage-providers/get-started/overview/index.md +++ b/content/en/storage-providers/get-started/overview/index.md @@ -1,7 +1,7 @@ --- title: "Overview" -description: "Miners in the Filecoin network are in charge of storing, providing content and issuing new blocks." -lead: "Miners in the Filecoin network are in charge of storing, providing content and issuing new blocks." +description: "Storage providers in the Filecoin network are in charge of storing, providing content and creating consensus." +lead: "Storage providers in the Filecoin network are in charge of storing, providing content and creating consensus." draft: false menu: storage-providers: @@ -13,15 +13,15 @@ weight: 110 toc: true --- -This sections contains guides to setup and run succesful mining operations using Lotus and should be approached by **advanced users only**, familiar with [how Filecoin works](https://docs.filecoin.io/about-filecoin/how-filecoin-works/), [how mining works](https://docs.filecoin.io/mine/how-mining-works/) and the operation of a Lotus node. +This section contains guides to initialize and run a successful storage provider operation using Lotus and should be approached by **advanced users only**. You should read through and be familiar with the concepts outlined in these two articles: [how Filecoin works](https://docs.filecoin.io/about-filecoin/how-filecoin-works/), [how mining works](https://docs.filecoin.io/mine/how-mining-works/), as well as having a Lotus node running. {{< alert icon="warning" >}} -Lotus Mining for _mainnet_ has stringent minimal **[hardware requirements]({{< relref "hardware-requirements" >}})**. Do not attempt this installation if your computer does not meet the minimum requirements. +Being a storage provider on the _mainnet_ has stringent minimal **[hardware requirements]({{< relref "hardware-requirements" >}})**. Do not attempt this installation if your server does not meet the minimum requirements. {{< /alert >}} -## Getting started with Lotus Miner +## How to read the storage provider documentation -The following guides are essential starting points for those willing to launch a Lotus miner: +The guides in this section is meant to introduce high level concepts early in the docs, and bring in more advanced topics and configurations later on. - The miner installation is covered in the [Installation guide]({{< relref "../../../lotus/install/prerequisites" >}}). Once the installation is complete, the Lotus node, Lotus miner, and Lotus worker applications should all be installed. From 6c894180964a448ecbb2ba507c0bbccba6748917 Mon Sep 17 00:00:00 2001 From: Rjan Date: Wed, 27 Apr 2022 14:23:12 +0200 Subject: [PATCH 2/5] Small fixes Some spelling fixes --- .../storage-providers/get-started/overview/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/storage-providers/get-started/overview/index.md b/content/en/storage-providers/get-started/overview/index.md index 28aa7e50..bf1237b4 100644 --- a/content/en/storage-providers/get-started/overview/index.md +++ b/content/en/storage-providers/get-started/overview/index.md @@ -21,12 +21,12 @@ Being a storage provider on the _mainnet_ has stringent minimal **[hardware requ ## How to read the storage provider documentation -The guides in this section is meant to introduce high level concepts early in the docs, and bring in more advanced topics and configurations later on. +The guides in this section are meant to introduce high-level concepts early in the docs and bring in more advanced topics and configurations later on. -- The miner installation is covered in the [Installation guide]({{< relref "../../../lotus/install/prerequisites" >}}). Once the installation is complete, the Lotus node, Lotus miner, and Lotus worker applications should all be installed. - -- The [Miner setup]({{< relref "initialize" >}}) covers all the details to configure your miner to achieve the maximum performance and avoid common pitfalls. -- The [Configuration reference]({{< relref "configuration" >}}) explains what the different miner configuration options mean. -- The [Seal workers]({{< relref "seal-workers" >}}) guide covers how to run additional seal workers co-located or not with the Lotus Miner. +- The `Get started` segment contains a high-level overview of the tasks the `lotus-miner` binary does, introduces the basic economics of being a storage provider, and outlines some hardware and architectural requirements. +- The `Setup` segment contains all the necessary information for initializing the storage provider on the network. +- The `Operate` segment contains the necessary information about operating the storage provider daily and introduces more complex operations like SnapDeals, Batching and Index Provider. +- The `Workers` segment contains guides for setting up dedicated workers for offloading tasks from the `lotus-miner` binary. +- The `Advanced onfigurations` segment details all the configurations you can tune to optimize your storage provider setup. We nevertheless recommend careful reading of every existing section and gaining as much background as possible before proceeding with a Lotus miner deployment. From 7f175bfa0d74bc0d48a807edc65b645b1219799d Mon Sep 17 00:00:00 2001 From: Rjan Date: Thu, 28 Apr 2022 09:38:14 +0200 Subject: [PATCH 3/5] Adding key conecpts Adding key concepts to the overview-page --- .../get-started/overview/index.md | 23 +++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/content/en/storage-providers/get-started/overview/index.md b/content/en/storage-providers/get-started/overview/index.md index bf1237b4..789b85c9 100644 --- a/content/en/storage-providers/get-started/overview/index.md +++ b/content/en/storage-providers/get-started/overview/index.md @@ -21,7 +21,7 @@ Being a storage provider on the _mainnet_ has stringent minimal **[hardware requ ## How to read the storage provider documentation -The guides in this section are meant to introduce high-level concepts early in the docs and bring in more advanced topics and configurations later on. +The guides in this section are meant to introduce high-level concepts early in the documentation and bring in more advanced topics and configurations later on. - The `Get started` segment contains a high-level overview of the tasks the `lotus-miner` binary does, introduces the basic economics of being a storage provider, and outlines some hardware and architectural requirements. - The `Setup` segment contains all the necessary information for initializing the storage provider on the network. @@ -29,4 +29,23 @@ The guides in this section are meant to introduce high-level concepts early in t - The `Workers` segment contains guides for setting up dedicated workers for offloading tasks from the `lotus-miner` binary. - The `Advanced onfigurations` segment details all the configurations you can tune to optimize your storage provider setup. -We nevertheless recommend careful reading of every existing section and gaining as much background as possible before proceeding with a Lotus miner deployment. +We recommend careful reading of every existing section and gaining as much background as possible before proceeding with a Lotus storage provider deployment. + +## Key concepts +You should be familiar with these key concepts related to being a storage provider before moving on to the next page. The Filecoin [glossary](https://spec.filecoin.io/#section-glossary) is handy when you need to look up a word or subject. + +### Sectors + +A sector is the default unit of storage that storage providers submit to the Filecoin network. Storage providers can decide if they want to commit 32 GiB or 64 GiB sector sizes when they first initialize their storage provider. It´s not possible to change the sector size once it has been initialized on-chain. + +A sector can contain data from multiple deals and clients. A storage provider can also submit “Committed Capacity” (CC) sectors. CC sectors are available to the Filecoin network as committed storage power but do not initially contain storage deals. Actively proving CC sectors can be upgraded at a later date to include storage deals in a process known as Snap Deals. + +**Sealed sectors** +An unsealed sector contains raw storage deal data. These sectors may optionally be retained if the client requires fast retrieval of their data. + +**Unsealed sectors** +A unsealed sector is the raw data. Some clients request that their unsealed data is kept for fast retrievals. + +### Epoch + +The passing of time on the Filecoin network is divided into epochs of 30 seconds in duration. For every new epoch, a subset of storage providers are elected to add a new block to the chain. \ No newline at end of file From 650f06c6cc26436a2e250bbf62a889e876b96166 Mon Sep 17 00:00:00 2001 From: Rjan Date: Thu, 5 May 2022 09:40:55 -0400 Subject: [PATCH 4/5] Full link path Add full path --- content/en/storage-providers/get-started/overview/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/storage-providers/get-started/overview/index.md b/content/en/storage-providers/get-started/overview/index.md index 789b85c9..88977d1e 100644 --- a/content/en/storage-providers/get-started/overview/index.md +++ b/content/en/storage-providers/get-started/overview/index.md @@ -16,7 +16,7 @@ toc: true This section contains guides to initialize and run a successful storage provider operation using Lotus and should be approached by **advanced users only**. You should read through and be familiar with the concepts outlined in these two articles: [how Filecoin works](https://docs.filecoin.io/about-filecoin/how-filecoin-works/), [how mining works](https://docs.filecoin.io/mine/how-mining-works/), as well as having a Lotus node running. {{< alert icon="warning" >}} -Being a storage provider on the _mainnet_ has stringent minimal **[hardware requirements]({{< relref "hardware-requirements" >}})**. Do not attempt this installation if your server does not meet the minimum requirements. +Being a storage provider on the _mainnet_ has stringent minimal **[hardware requirements]({{< relref "../../../storage-providers/get-started/hardware-requirements" >}})**. Do not attempt this installation if your server does not meet the minimum requirements. {{< /alert >}} ## How to read the storage provider documentation From c55c62f7383e1b9920377fcec0afa429fc02e5cf Mon Sep 17 00:00:00 2001 From: Phi-rjan Date: Thu, 5 May 2022 10:27:47 -0400 Subject: [PATCH 5/5] Update content/en/storage-providers/get-started/overview/index.md Co-authored-by: TippyFlits --- content/en/storage-providers/get-started/overview/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/storage-providers/get-started/overview/index.md b/content/en/storage-providers/get-started/overview/index.md index 88977d1e..5e34d7ea 100644 --- a/content/en/storage-providers/get-started/overview/index.md +++ b/content/en/storage-providers/get-started/overview/index.md @@ -44,7 +44,7 @@ A sector can contain data from multiple deals and clients. A storage provider ca An unsealed sector contains raw storage deal data. These sectors may optionally be retained if the client requires fast retrieval of their data. **Unsealed sectors** -A unsealed sector is the raw data. Some clients request that their unsealed data is kept for fast retrievals. +An unsealed sector is the raw data. Some clients request that their unsealed data is kept for fast retrievals. ### Epoch