Documentation Updates #1814
Documentation Updates #1814
Conversation
Added Documentation for creating a new Network (cherry picked from commit fe1632e) Signed-off-by: Philipp Schlarb <p.schlarb@esatus.com>
Signed-off-by: Philipp Schlarb <p.schlarb@esatus.com>
Signed-off-by: Philipp Schlarb <p.schlarb@esatus.com>
|
@lynnbendixsen, Could you review the documentation please. Focusing on |
|
@pSchlarb, I think we should switch to |
|
Yeah sure I can change it, but I would walk through it myself first to see if it works. Not sure if I can finish that before tomorrows contributors call. |
You'll find the installation is a bit different. |
Signed-off-by: Philipp Schlarb <p.schlarb@esatus.com>
|
Just testet the documentation with indy-cli-rs it works fine. Should the old indy-cli install be deleted from the docs in all and only reference indy-cli-rs or bundled von network? |
Yes, you can remove the references to the |
|
@WadeBarnes — leaving this to merge for you. Looks good, but I didn’t walk through it... |
Signed-off-by: Philipp Schlarb <p.schlarb@esatus.com>
pSchlarb
force-pushed
the
documentationUpdate
branch
from
b8b6bfd to
175e44f
Compare
docs/source/configuring-2nics.md
Outdated
There was a problem hiding this comment.
This document needs to be updated with the steps using netplan on Ubuntu 20.04. @lynnbendixsen, would you be able to lend your updated wording to this document?
There was a problem hiding this comment.
The installation section needs to be updated with the Ubuntu 20.04 instructions. I can look into that.
Signed-off-by: Wade Barnes <wade@neoterictech.ca>
docs/source/NewNetwork/NewNetwork.md
Outdated
|
|
||
| Initial Trustees (3 preferred) must create and submit a Trustee DID and Verkey so that the domain genesis file can be built. | ||
|
|
||
| Each trustee has to [instal the `indy-cli`](./CLIInstall.md) and [create a Trustee DID](./CreateDID.md). |
There was a problem hiding this comment.
instal should be install here
docs/source/NewNetwork/NewNetwork.md
Outdated
|
|
||
| A Steward is an organization responsible for running a Node on the Network | ||
|
|
||
| Exactly 4 “Genesis” Stewards are needed to establish the network, more Stewards can be added later. |
There was a problem hiding this comment.
I recommend changing this to:
"Exactly 4 “Genesis” Stewards are required to establish the network, but at least 7 are recommended for a production network that you expect to last for a long time. More Stewards can be added later.
docs/source/NewNetwork/NewNetwork.md
Outdated
| 1. Determine a name for the new network and have the stewards substitute it in the appropriate places in the guide, such as when setting the network name and creating the directory when creating the keys for the node. | ||
| 1. They all need to stop at the normal place ([3.5. Add Node to a Pool](../installation-and-configuration.md#3.5.-Add-Node-to-a-Pool)) as instructed in the guide as the steps that follow differ when creating a new network. The following sections of this guide describe the steps required to start the new network. | ||
|
|
||
| Once the Stewards have created their DID and Verkey, and performed the initial setup of they node, give the Stewards access to a spreadsheet like [this one](https://docs.google.com/spreadsheets/d/1LDduIeZp7pansd9deXeVSqGgdf0VdAHNMc7xYli3QAY/edit#gid=0) and have them fill out their own row of the Stewards sheet. The completed sheet will be used to generate the genesis transaction files for the network. |
There was a problem hiding this comment.
"setup of they node" should be "setup of their node"
Signed-off-by: pSchlarb <p.schlarb@esatus.com>
|
@lynnbendixsen, Could you have a look at the NIC configuration and update it as needed for Ubuntu 20.04 (to use netplan)? |
|
I am wondering if it's best to remove the "configuring-2nics.md" file, or maybe shortening it to just include a single line like 'To configure 2 nics refer to the platform specific instructions included as part of the *-NodeInstall-20.04.md documents included in the indy-node/docs/source/install-docs directory'] |
|
Yes, take advantage of the additional documentation and reference it. |
Cherry picked the
New Network from Scratchdocumentation,updated the
indy-clireferences to includeindy-cli-rsand fixed the Python3.5 reference as pointed out in #1811.
Feel free to make changes to this PR, which is open for edits.