Updated README links & terminology #1089
Conversation
0xmgb
requested review from
wizeguyy,
kiltsonfire and
gameofpointers
as code owners
README.md
Outdated
| @@ -44,47 +43,49 @@ directory. | |||
|
|
|||
| | Command | Description | | |||
| | :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |||
| | **`go-quai`** | Our main Quai CLI client. It is the entry point into the Quai network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Quai network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `go-quai --help` for command line options.| | |||
| | **`go-quai`** | Our main Quai CLI client. It is the entry point into the Quai network (main-, test- or private net), capable of running as a global node (all chains), base node (subset of chains), archive node (retaining all historical state), or a light node (retrieving data live). It can be used by other processes as a gateway into the Quai network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `go-quai --help` for command line options.| | |||
There was a problem hiding this comment.
capable of running as a global node (all chains)
Are we referring to them as chains? I thought we were going to start referring to them as zones or slices.
base node (subset of chains)
I think this line needs rewording still. There is a difference between the network topology that a node connects to (slice, multi-slice, all-slices) and the operating behavior of the node (light node, full node, archive node, etc...). For example, we can have an archive slice node, or a light global node. Or a global archive node. Or any permutation of:
| 1-slice | N-slices | all-slices | |
|---|---|---|---|
| archive node | slice archive? | multi-slice archive? | global archive? |
| full node | slice full? | multi-slice full? | global full? |
| light node | slice light? | multi-slice light? | global light? |
| others? | ... | ... | ... |
I think we want terminology that encompass that table of node types ^, but I'm not sure exactly what that terminology should be
There was a problem hiding this comment.
After discussion in person, the conclusions are:
- use slice, instead of chain or zone
- use the names given in the table above^
Some example names:
global archive node
light multi-slice node
full slice node
README.md
Outdated
| ### Full node on the main Quai network | ||
| ### Configuration | ||
|
|
||
| Configuration is handled in `network.env.dist` file. You will need to copy or rename the file to `network.env`. The make commands will automatically pull from this file for configuration changes. |
There was a problem hiding this comment.
Configuration is handled in network.env, not network.env.dis. network.env.dist is just an example env file we distribute
Updated README links & terminology
Revert "Updated README links & terminology"
@dominant-strategies/core-dev
Hello,
I changed the README file by updating some links (current docs link is broken), changing terminology (global node and base node) and reorganizing the "running go-quai" page by going from configuration->global->base->logs->garden instead of global->garden->logs->configuration.