Docs revamp #302
Closed
Docs revamp #302
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
❌ Deploy Preview for obol-docs failed.
|
added 2 commits
January 29, 2024 15:40
…fault, and that the network can be changed with the .env.sample file. This should go live on Feb 6th, at the same time that we change CDVN to Holesky by default.
added 2 commits
February 5, 2024 12:37
…inks, rather than a link directly to the Goerli launchpad page
thomasheremans
requested changes
Feb 8, 2024
| @@ -20,7 +20,8 @@ Alternatively, the private key shares can be created in a lower-trust manner wit | |||
|
|
|||
| ## Pre-requisites | |||
|
|
|||
| - Ensure you have [docker](https://docs.docker.com/engine/install/) installed. | |||
| - A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators. | |||
| - Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed. | |||
There was a problem hiding this comment.
it doesn't have to be docker desktop, in fact most people will only have the engine installed and not the UI as they are not running a node with a UI framework installed
| @@ -28,7 +28,8 @@ The default cluster consists of: | |||
|
|
|||
| ## Pre-requisites | |||
|
|
|||
| - Ensure you have [docker](https://docs.docker.com/engine/install/) installed. | |||
| - A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators. | |||
| - Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed. | |||
| @@ -13,7 +13,8 @@ The following instructions aim to assist a group of operators coordinating toget | |||
|
|
|||
| ## Pre-requisites | |||
|
|
|||
| - Ensure you have [docker](https://docs.docker.com/engine/install/) installed. | |||
| - A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators. | |||
| - Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed. | |||
| @@ -20,7 +20,8 @@ These roles hold no position of privilege in the cluster, they only set the init | |||
| The person creating the cluster <b>will</b> be a node operator in the cluster.<br /><br /> | |||
| <h1>Pre-requisites</h1> | |||
| <ul> | |||
| <li>Ensure you have <a href="https://docs.docker.com/engine/install/" target="_blank">docker</a> installed.</li> | |||
| <li>A basic <a href="https://docs.ethstaker.cc/ethstaker-knowledge-base/" target="_blank">knowledge</a> of Ethereum nodes and validators.</li> | |||
| <li>Ensure you have <a href="https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop" target="_blank">docker</a> installed.</li> | |||
| - You have [enough up-to-spec nodes](../key-concepts.md#distributed-validator-threshold) for your mainnet deployment. | ||
| - Ensure you have [docker](https://docs.docker.com/engine/install/) installed on each node. | ||
| - Ensure you have [docker](https://docs.docker.com/desktop/install/linux-install/#generic-installation-steps) installed on each node. |
| <p align="center"><iframe width="560" height="315" src="https://www.youtube.com/embed/6pXASqjAQbs" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></p> | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| - Ensure you have [docker](https://docs.docker.com/engine/install/) installed. | ||
| - A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators. | ||
| - Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed. |
| The `charon-distributed-validator-node` repo is set by default to the Holesky testnet. If you wish to change the network, copy the file `.env.sample` inside the `charon-distributed-validator-node` folder, uncommenting line 5 and setting a value for `NETWORK`, saving the new file with the name `.env`. | ||
|
|
||
| .env.sample is a sample environment file that allows overriding default configuration defined in docker-compose.yml. Uncomment and set any variable to override its value. | ||
| ::: |
There was a problem hiding this comment.
This is good but not sure it is in the right place. On this page before running the node is probably better? http://localhost:3000/docs/next/int/quickstart/group/quickstart-group-operator. As per the other conversation, this will only be relevant for the users using docker CDVN and should be under a tab moving forward
added 3 commits
February 12, 2024 16:16
…Max's_docs_edits
…Max's_docs_edits
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Overhauling the docs to improve the flow for users. (Simplifying the quick start guides, removing duplicate information, reducing "sections within sections", etc.)
Details
Working out of this to-do list
https://docs.google.com/document/d/1H-K_zKSZNMwK45p4_udEJkTxSzSUN8siJvuYg7Dq7gA/edit
ticket: