Skip to content

Commit 7949ce3

Browse files
authored
Merge pull request #1061 from olgahryniuk/patch-1
Tech writing review
2 parents 7c0891f + 1553803 commit 7949ce3

File tree

4 files changed

+80
-82
lines changed

4 files changed

+80
-82
lines changed

docs/root/manual/getting-started/SPO-on-boarding-guide.md

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,46 @@ sidebar_position: 1
55
import NetworksMatrix from '../../networks-matrix.md';
66
import CompiledBinaries from '../../compiled-binaries.md'
77

8-
# SPO On-boarding Guide
8+
# SPO onboarding guide
99

1010
## The journey with Mithril toward `mainnet`
1111

12-
Welcome to Mithril! Here is a description of the journey you will have to follow as a SPO in order to get ready for running a **Mithril Signer** in the `mainnet`.
13-
We are assuming that you are already an active SPO on the Cardano `mainnet` and at least on the `preprod` testnet.
12+
Welcome to Mithril! Here is a description of the journey you will need to follow as an SPO to prepare for running a Mithril Signer on the `mainnet`. We assume that you are already an active SPO on the Cardano `mainnet` and have experience on the `pre-production` testnet.
1413

1514
<!---
16-
This diagram randomly crashes. We replace it with screeenshot until aif xi s available
15+
This diagram randomly crashes. We replace it with a screenshot until aif xi s available
1716
TODO: revert this modification when it is possible
1817
```mermaid
1918
timeline
20-
section Cardano Preview
21-
SPO Pioneer Program : Optional : SPO test Mithril distributions pre-release with IOG : Run Mithril Signer in `pre-release-preview` network : Naive or Production deployment : ~2-3 days
22-
section Cardano Preprod
23-
SPO Beta Mainnet Preparation : Mandatory : SPO validates that Mithril is working in test environment : Run Mithril Signer in `release-preprod` network : Production deployment : ~10-15 days
24-
section Cardano Mainnet
25-
SPO Beta Mainnet Deployment : Mandatory : SPO runs Mithril in their mainnet infrastructure : Run Mithril Signer in `release-mainnet` network : Production deployment : ~10-15 days
19+
section Preview testing environment
20+
SPO Pioneer Program : Optional : SPOs test Mithril pre-releases with IOG : Run Mithril Signer in `pre-release-preview` network : Naive or Production deployment : ~2-3 days
21+
section Pre-production testing environment
22+
SPO beta mainnet preparation : Mandatory : SPOs validate that Mithril is working in the test environment : Run Mithril Signer in `release-preprod` network : Production deployment : ~10-15 days
23+
section Cardano mainnet
24+
SPO beta mainnet deployment : Mandatory : SPOs run Mithril in their mainnet infrastructure : Run Mithril Signer in `release-mainnet` network : Production deployment : ~10-15 days
2625
```
2726
-->
2827
![SPO On-boarding Timeline](images/spo-onboarding-timeline.png)
2928

30-
## Step 1: Participate to the Pioneer Program
29+
## Step 1: Participate in the Pioneer Program
3130

3231
:::info
3332

3433
This step is **optional**, but recommended as it helps us deliver quality software. We are actively looking for SPO candidates to test Mithril on the Cardano testnets. Contact us [here](https://contact.mithril.network/) if you are interested!
3534

3635
:::
3736

38-
In order to participate to the Pioneer Program, you will need to:
39-
- Register to the **Mithril SPO Pioneer Program** with this [form](https://contact.mithril.network/).
40-
- Run an active SPO on the Cardano `preview` network (registered for a least `1` epoch or `1` day).
41-
- Setup a **Mithril Signer** node on the `pre-release-preview` Mithril network by following the [**Run a Mithril Signer node (SPO)**](run-signer-node.md) guide.
42-
- You can run at your convenience the **Naive** (easier to setup) or the **Production** deployment model.
43-
- Wait for `2` epochs (or `2` days) before your **Mithril Signer** is eligible to contribute.
44-
- Verify that your **Pool Id** is listed in some of the produced certificates with the [**Mithril Explorer**](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.pre-release-preview.api.mithril.network%2Faggregator).
45-
- :warning: Follow our [**#moria**](https://discord.gg/5kaErDKDRq) discord channel or our [**GitHub repository**](https://github.com/input-output-hk/mithril/releases?q=pre) for new pre-releases to install.
46-
- Feel free to ask questions about any technical issue and/or provide feedback on the [**#moria**](https://discord.gg/5kaErDKDRq) discord channel.
37+
To participate in the Pioneer Program, you will need to:
38+
- Register for the **Mithril SPO Pioneer Program** using this [form](https://contact.mithril.network/).
39+
- Run an active SPO on the Cardano `preview` network for at least one epoch or one day.
40+
- Set up a **Mithril Signer** node on the `pre-release-preview` Mithril network by following the [**Run a Mithril Signer node (SPO)**](run-signer-node.md) guide.
41+
- You can choose between the **Naive** (easier to set up) or the **Production** deployment models.
42+
- Wait for two epochs (or two days) before your **Mithril Signer** is eligible to contribute.
43+
- Verify that your **Pool Id** is listed in some of the produced certificates using the [**Mithril Explorer**](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.pre-release-preview.api.mithril.network%2Faggregator).
44+
- :warning: Follow our [**#moria**](https://discord.gg/5kaErDKDRq) Discord channel or our [**GitHub repository**](https://github.com/input-output-hk/mithril/releases?q=pre) for new pre-releases to install.
45+
- If you have any technical issues or would like to provide feedback, feel free to ask questions on the [**#moria**](https://discord.gg/5kaErDKDRq) Discord channel.
4746

48-
Each **Mithril Network** has its own configuration, which is accessible in the [Configuration Parameters](#configuration-parameters) section of this guide.
47+
Each **Mithril network** has its own configuration, which can be found in the [Configuration parameters](#configuration-parameters) section of this guide.
4948

5049
## Step 2: Get Mithril ready for `mainnet`
5150

@@ -55,41 +54,41 @@ This step is **mandatory**. You must complete it before moving forward to **Step
5554

5655
:::
5756

58-
In order to get ready for `mainnet`, you need to:
59-
- Run an active SPO on the Cardano `preprod` network (registered for a least `1` epoch or `5` days).
60-
- Setup a **Mithril Signer** node on the `release-preprod` Mithril network by following the [**Run a Mithril Signer node (SPO)**](run-signer-node.md) guide.
57+
To get ready for `mainnet`, you need to:
58+
- Be an active SPO on the Cardano `preprod` network for at least one epoch or five days.
59+
- Set up a **Mithril Signer** node on Mithril's `release-preprod` network by following the [**Run a Mithril Signer node (SPO)**](run-signer-node.md) guide.
6160
- You **must** run the **Production** deployment model.
62-
- Wait for `2` epochs (or `10` days) before your **Mithril Signer** is eligible to contribute.
63-
- Verify that your **Pool Id** is listed in some of the produced certificates with the [**Mithril Explorer**](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.release-preprod.api.mithril.network%2Faggregator).
64-
- :warning: Follow our [**#moria**](https://discord.gg/5kaErDKDRq) discord channel or our [**GitHub repository**](https://github.com/input-output-hk/mithril/releases/latest) for new releases to install.
65-
- Feel free to ask questions about any technical issue and/or provide feedback on the [**#moria**](https://discord.gg/5kaErDKDRq) discord channel.
61+
- Wait for two epochs (or ten days) before your **Mithril Signer** is eligible to contribute.
62+
- Verify that your **Pool Id** is listed in some of the produced certificates using the [**Mithril Explorer**](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.release-preprod.api.mithril.network%2Faggregator).
63+
- :warning: Follow our [**#moria**](https://discord.gg/5kaErDKDRq) Discord channel or our [**GitHub repository**](https://github.com/input-output-hk/mithril/releases/latest) for new releases to install.
64+
- If you have any technical issues or would like to provide feedback, feel free to ask questions on the [**#moria**](https://discord.gg/5kaErDKDRq) Discord channel.
6665

67-
Each **Mithril Network** has its own configuration, which is accessible in the [Configuration Parameters](#configuration-parameters) section of this guide.
66+
Each **Mithril network** has its own configuration, which can be found in the [Configuration parameters](#configuration-parameters) section of this guide.
6867

69-
## Step 3: Run Mithril on the `mainnet`
68+
## Step 3: Run Mithril on `mainnet`
7069

7170
:::warning
7271

7372
This step is **mandatory**. You must have completed **Step 2** before.
7473

75-
The `release-mainnet` is not available yet, you will be notified when the service is opened.
74+
The `release-mainnet` is not yet available. You will be notified when the service is open.
7675

7776
:::
7877

79-
In order to run **Mithril** on the `mainnet`, you need to:
80-
- Run an active SPO on the Cardano `mainnet` network (registered for a least `1` epoch or `5` days).
81-
- Setup a **Mithril Signer** node on the `release-mainnet` Mithril network by following the [**Run a Mithril Signer node (SPO)**](run-signer-node.md) guide.
78+
To run **Mithril** on `mainnet`, you need to:
79+
- Be an active SPO on Cardano `mainnet` for at least one epoch or five days.
80+
- Set up a **Mithril Signer** node on Mithril's `release-mainnet` network by following the [**Run a Mithril Signer node (SPO)**](run-signer-node.md) guide.
8281
- You **must** run the **Production** deployment model.
83-
- Wait for `2` epochs (or `10` days) before your **Mithril Signer** is eligible to contribute.
84-
- Verify that your **Pool Id** is listed in some of the produced certificates with the [**Mithril Explorer**](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.release-mainnet.api.mithril.network%2Faggregator).
85-
- :warning: Follow our [**#moria**](https://discord.gg/5kaErDKDRq) discord channel or our [**GitHub repository**](https://github.com/input-output-hk/mithril/releases/latest) for new releases to install.
86-
- Feel free to ask questions about any technical issue and/or provide feedback on the [**#moria**](https://discord.gg/5kaErDKDRq) discord channel.
82+
- Wait for two epochs (or ten days) before your **Mithril Signer** is eligible to contribute.
83+
- Verify that your **Pool Id** is listed in some of the produced certificates using the [**Mithril Explorer**](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.release-mainnet.api.mithril.network%2Faggregator).
84+
- :warning: Follow our [**#moria**](https://discord.gg/5kaErDKDRq) Discord channel or our [**GitHub repository**](https://github.com/input-output-hk/mithril/releases/latest) for new releases to install.
85+
- If you have any technical issues or would like to provide feedback, feel free to ask questions on the [**#moria**](https://discord.gg/5kaErDKDRq) Discord channel.
8786

88-
Each **Mithril Network** has its own configuration, which is accessible in the [Configuration Parameters](#configuration-parameters) section of this guide.
87+
Each **Mithril network** has its own configuration, which can be found in the [Configuration parameters](#configuration-parameters) section of this guide.
8988

90-
## Configuration Parameters
89+
## Configuration parameters
9190

92-
:::note Mithril Networks
91+
:::note Mithril networks
9392

9493
<NetworksMatrix />
9594

1.73 KB
Loading

0 commit comments

Comments
 (0)