Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

content: Lighthouse docs should follow Lighthouse defaults #350

Open
plato-gno opened this issue Jan 8, 2023 · 0 comments
Open

content: Lighthouse docs should follow Lighthouse defaults #350

plato-gno opened this issue Jan 8, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation section:node operators

Comments

@plato-gno
Copy link
Contributor

plato-gno commented Jan 8, 2023

Our Lighthouse docs currently differ from Lighthouse's file structure and defaults.

We should try to stick as close to Lighthouse's defaults, so we can refer the user as much as possible to their documentation. This reduces our long-term documentation lift.

This may require us to review how we structure our overall validator documentation, as we shift towards native client documentation.

Example 1: Different datadir

  • Lighthouse Book: defaults to .lighthouse/gnosis
  • Our documentation: /home/gnosis/consensus

See https://lighthouse-book.sigmaprime.io/validator-management.html

Example 2: Uses validator_definitions.yml to configure

See https://lighthouse-book.sigmaprime.io/validator-management.html

Example 3: Importing validator_keys

  • Lighthouse book: imports from validator_keys directory
  • Our documentation: uses different volumes

See https://lighthouse-book.sigmaprime.io/validator-import-launchpad.html

@plato-gno plato-gno added the documentation Improvements or additions to documentation label Jan 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation section:node operators
Projects
None yet
Development

No branches or pull requests

2 participants