diff --git a/docs/07-resources/_category_.json b/docs/07-resources/_category_.json deleted file mode 100644 index 49f11bc48..000000000 --- a/docs/07-resources/_category_.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "position": 7, - "label": "Resources", - "collapsible": true, - "link": { - "type": "generated-index" - }, - "customProps": { - "description": "General overview and introduction of Nethermind Execution Client" - } -} diff --git a/docs/developers/_category_.json b/docs/developers/_category_.json index 365dd0a3a..6e6ab0704 100644 --- a/docs/developers/_category_.json +++ b/docs/developers/_category_.json @@ -1,5 +1,5 @@ { - "position": 5, + "position": 6, "label": "Developers", "collapsible": true, "link": { diff --git a/docs/resources/_category_.json b/docs/resources/_category_.json new file mode 100644 index 000000000..2624439e8 --- /dev/null +++ b/docs/resources/_category_.json @@ -0,0 +1,8 @@ +{ + "position": 8, + "label": "Resources", + "collapsible": true, + "link": { + "type": "generated-index" + } +} diff --git a/docs/07-resources/connecting-wallet.md b/docs/resources/connecting-wallet.md similarity index 100% rename from docs/07-resources/connecting-wallet.md rename to docs/resources/connecting-wallet.md diff --git a/docs/07-resources/faq.md b/docs/resources/faq.md similarity index 96% rename from docs/07-resources/faq.md rename to docs/resources/faq.md index 5828076b5..a458dcf99 100644 --- a/docs/07-resources/faq.md +++ b/docs/resources/faq.md @@ -64,10 +64,10 @@ You can find more details on the logging config page [here](../fundamentals/logs ## How can I configure validator on AuRa / Clique? You can find more details on running validators in the docs -> -for [AuRa](./guides-and-helpers/validator-setup/aura-validator.md) and +for [AuRa](../validators/aura-validator.md) and for [Clique](../fundamentals/private-networks/clique.md). -You can learn more about how to setup a aura validator [here](./guides-and-helpers/validator-setup/aura-validator.md) +You can learn more about how to setup a aura validator [here](../validators/aura-validator.md) ## My network bandwidth is used up by the Nethermind node diff --git a/docs/07-resources/firewall-configuration.md b/docs/resources/firewall-configuration.md similarity index 100% rename from docs/07-resources/firewall-configuration.md rename to docs/resources/firewall-configuration.md diff --git a/docs/07-resources/guides-and-helpers/_category_.json b/docs/resources/guides-and-helpers/_category_.json similarity index 100% rename from docs/07-resources/guides-and-helpers/_category_.json rename to docs/resources/guides-and-helpers/_category_.json diff --git a/docs/07-resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md b/docs/resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md similarity index 96% rename from docs/07-resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md rename to docs/resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md index 2b82738dd..02c66fdf3 100644 --- a/docs/07-resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md +++ b/docs/resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md @@ -44,7 +44,7 @@ Enable **JSON RPC** service so that your ETH2 Beacon node will be able to commun ::: :::danger -Remember to setup you [firewall configuration](../../07-resources/firewall-configuration.md) +Remember to setup you [firewall configuration](../../resources/firewall-configuration.md) ::: Configure EthStats for your node if needed: diff --git a/docs/07-resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md b/docs/resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md similarity index 100% rename from docs/07-resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md rename to docs/resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md diff --git a/docs/07-resources/know-issues.md b/docs/resources/know-issues.md similarity index 100% rename from docs/07-resources/know-issues.md rename to docs/resources/know-issues.md diff --git a/docs/utilities/_category_.json b/docs/utilities/_category_.json index 718077b00..195fc2aed 100644 --- a/docs/utilities/_category_.json +++ b/docs/utilities/_category_.json @@ -1,5 +1,5 @@ { - "position": 6, + "position": 7, "label": "Utilities", "collapsible": true, "link": { diff --git a/docs/validators/_category_.json b/docs/validators/_category_.json new file mode 100644 index 000000000..57d553655 --- /dev/null +++ b/docs/validators/_category_.json @@ -0,0 +1,8 @@ +{ + "position": 5, + "label": "Validators", + "collapsible": true, + "link": { + "type": "generated-index" + } +} diff --git a/docs/07-resources/guides-and-helpers/validator-setup/aura-validator.md b/docs/validators/aura-validator.md similarity index 90% rename from docs/07-resources/guides-and-helpers/validator-setup/aura-validator.md rename to docs/validators/aura-validator.md index 0e0a9f6bd..ded7e397a 100644 --- a/docs/07-resources/guides-and-helpers/validator-setup/aura-validator.md +++ b/docs/validators/aura-validator.md @@ -1,15 +1,12 @@ --- -description: >- - How to setup a Nethermind Validator in Aura (Authority Round) consensus - algorithm +title: Aura Validator +sidebar_position: 1 --- -# Aura Validator - This article will lead you through docker-compose setup of **Nethermind Aura Validator** (xDai chain in this example). Same result can be obtained -by [Downloading](../../../get-started/installing-nethermind.md) & [Running Nethermind](../../../fundamentals/running-nethermind.md) -package or by [Building Nethermind](../../../developers/building-from-source.md) from the source code. +by [Downloading](../get-started/installing-nethermind.md) & [Running Nethermind](../fundamentals/running-nethermind.md) +package or by [Building Nethermind](../developers/building-from-source.md) from the source code. If you chose not to use docker-compose, you can skip docker-compose related sections and read about [config file](aura-validator.md#config-file) and [private key ](aura-validator.md#mining-private-key)configuration @@ -108,8 +105,8 @@ container (`xdai.cfg` file in above example). Make sure that `nethermind_db`, `keystore`(`logs` - optional ) are mapped, otherwise you might lose database or keys ::: -[`NLog.config`](../../../fundamentals/running-nethermind.md) file is optional.\ -[`static-nodes.json`](../../../fundamentals/running-nethermind.md) can be filled with an +[`NLog.config`](../fundamentals/running-nethermind.md) file is optional.\ +[`static-nodes.json`](../fundamentals/running-nethermind.md) can be filled with an array of enodes, this is also optional. @@ -133,7 +130,7 @@ Things to be configured: for `xdai` 1000000000 is enough) * [ ] `EthStats` section if you wish to report node status to the ethstats page for a given network * [ ] `Metrics` section if running - local/remote [Metrics infrastructure](../../../monitoring/metrics/setting-up-local-metrics-infrastracture.md) + local/remote [Metrics infrastructure](../monitoring/metrics/setting-up-local-metrics-infrastracture.md) * [ ] `KeyStore.PasswordFiles` path to the file containing password for **mining private key** * [ ] `KeyStore.UnlockAccounts` an array of accounts, provide **mining public address** here * [ ] `KeyStore.BlockAuthorAccount` **mining public address** should be provided here as well diff --git a/docs/07-resources/guides-and-helpers/validator-setup/eth2-validator.md b/docs/validators/eth2-validator.md similarity index 99% rename from docs/07-resources/guides-and-helpers/validator-setup/eth2-validator.md rename to docs/validators/eth2-validator.md index 663b73c50..4c9a9f0b8 100644 --- a/docs/07-resources/guides-and-helpers/validator-setup/eth2-validator.md +++ b/docs/validators/eth2-validator.md @@ -1,8 +1,11 @@ +--- +title: Eth2 Validator +sidebar_position: 0 +--- + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# Eth2 Validator - ## Introduction This tutorial will allow anyone to set up an Ethereum Validator node as long as you have the sufficient hardware @@ -64,7 +67,7 @@ Run the following command to install Nethermind: sudo add-apt-repository ppa:nethermindeth/nethermind; sudo apt install nethermind ``` -See [here](../../../get-started/consensus-clients.md) for docs for +See [here](../get-started/consensus-clients.md) for docs for other ways to install Nethermind. #### **Installing Consensus Client** @@ -146,7 +149,7 @@ sudo chown -R nethermindeth:nethermindeth /usr/share/nethermind Create a JWT Token which will be used to communicate between consensus and execution clients. For more information about JWT Token please refer -to [this section](../../../get-started/consensus-clients.md#step-3--configure-json-rpc-api). +to [this section](../get-started/consensus-clients.md#step-3--configure-json-rpc-api). ```bash openssl rand -hex 32 | tr -d "\n" > "/var/lib/nethermind/jwt-secret"