status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book/mkdocs.yml

126 lines
2.9 KiB
YAML
Raw Normal View History

Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
Initial public version of the Verifying Web3Signer functionality (#4912) * Allow the list of proved properties for web3signer to be configured * Document the Web3Signer setups (regular, distributed and verified)
2023-05-09 08:16:43 +00:00
# nimbus_guide
# Copyright (c) 2022-2023 Status Research & Development GmbH
# Licensed and distributed under either of
# * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
# * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
# at your option. This file may not be copied, modified, or distributed except according to those terms.
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
site_name: The Nimbus Guide
theme:
name: material
features:
- navigation.expand
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- navigation.tabs
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- navigation.top
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- content.tabs.link
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
palette:
scheme: default
primary: orange
accent: amber
# Support urls previously used by mdbook
use_directory_urls: false
repo_url: https://github.com/status-im/nimbus-eth2
edit_uri: edit/unstable/docs/the_nimbus_book/src
site_url: https://nimbus.guide
docs_dir: src
markdown_extensions:
- admonition
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- meta
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- tables
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- toc:
toc_depth: 3
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
nav:
Update "Getting started" part of the book (#4938) * refactor index.md * move philosophy.md into index.md * clean up the 'getting started' topic move how-to's to the how-to section * cleaner titles * move prerequisites to the install.md page * hardware.md: small refactor * improve quick-start.md * refactor eth1.md * refactor validating guide * reverse the order of BN and LC in the table * pi-guide.md: minor edit * Apply suggestions from code review Co-authored-by: tersec <tersec@users.noreply.github.com> * make link texts more concrete * remove comparison to other clients * add some more explanations to `build.md` * change 'days' to 'hours' --------- Co-authored-by: tersec <tersec@users.noreply.github.com>
2023-06-09 23:06:01 +00:00
- Home:
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'index.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- Getting started:
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'quick-start.md'
- 'run-a-validator.md'
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'el-light-client.md'
Update "Getting started" part of the book (#4938) * refactor index.md * move philosophy.md into index.md * clean up the 'getting started' topic move how-to's to the how-to section * cleaner titles * move prerequisites to the install.md page * hardware.md: small refactor * improve quick-start.md * refactor eth1.md * refactor validating guide * reverse the order of BN and LC in the table * pi-guide.md: minor edit * Apply suggestions from code review Co-authored-by: tersec <tersec@users.noreply.github.com> * make link texts more concrete * remove comparison to other clients * add some more explanations to `build.md` * change 'days' to 'hours' --------- Co-authored-by: tersec <tersec@users.noreply.github.com>
2023-06-09 23:06:01 +00:00
- 'pi-guide.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- How-to:
- Beacon node:
- 'install.md'
- 'build.md'
- 'start-syncing.md'
- 'trusted-node-sync.md'
Update "Getting started" part of the book (#4938) * refactor index.md * move philosophy.md into index.md * clean up the 'getting started' topic move how-to's to the how-to section * cleaner titles * move prerequisites to the install.md page * hardware.md: small refactor * improve quick-start.md * refactor eth1.md * refactor validating guide * reverse the order of BN and LC in the table * pi-guide.md: minor edit * Apply suggestions from code review Co-authored-by: tersec <tersec@users.noreply.github.com> * make link texts more concrete * remove comparison to other clients * add some more explanations to `build.md` * change 'days' to 'hours' --------- Co-authored-by: tersec <tersec@users.noreply.github.com>
2023-06-09 23:06:01 +00:00
- 'migration.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- Validator:
- 'deposit.md'
- 'keys.md'
- 'connect-eth2.md'
- 'graffiti.md'
- 'suggested-fee-recipient.md'
document external block builder configuration (#4032) * document external block builder configuration * Update docs/the_nimbus_book/src/external-block-builder.md Co-authored-by: Jacek Sieka <jacek@status.im> * unhide external payload builder options * clarify builder API incentive misalignment Co-authored-by: Jacek Sieka <jacek@status.im>
2022-08-29 09:59:12 +00:00
- 'external-block-builder.md'
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- 'keep-an-eye.md'
- 'more-keys.md'
- 'additional-validator.md'
- 'validator-client.md'
Add a guide for withdrawals (#4790)
2023-04-05 16:23:23 +00:00
- 'withdrawals.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- General:
- 'keep-updated.md'
- 'eth1.md'
- 'goerli-eth.md'
- 'beacon-node-systemd.md'
- 'log-rotate.md'
Update "Getting started" part of the book (#4938) * refactor index.md * move philosophy.md into index.md * clean up the 'getting started' topic move how-to's to the how-to section * cleaner titles * move prerequisites to the install.md page * hardware.md: small refactor * improve quick-start.md * refactor eth1.md * refactor validating guide * reverse the order of BN and LC in the table * pi-guide.md: minor edit * Apply suggestions from code review Co-authored-by: tersec <tersec@users.noreply.github.com> * make link texts more concrete * remove comparison to other clients * add some more explanations to `build.md` * change 'days' to 'hours' --------- Co-authored-by: tersec <tersec@users.noreply.github.com>
2023-06-09 23:06:01 +00:00
- 'metrics-pretty-pictures.md'
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- 'database-backup.md'
- 'email-notifications.md'
- 'profits.md'
- 'health.md'
- 'prater.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- Security:
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
- 'preparation.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'security_issues.md'
- 'audit.md'
- 'distribution_internals.md'
- Reference:
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'hardware.md'
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
- Advanced options:
- 'options.md'
- 'networking.md'
- 'optimistic-sync.md'
- 'light-client-data.md'
- 'logging.md'
- 'validator-client-options.md'
- 'validator-monitor.md'
unify bn/vc doppelganger detection (#4398) * fix REST liveness endpoint responding even when gossip is not enabled * fix VC exit code on doppelganger hit * fix activation epoch not being updated correctly on long deposit queues * fix activation epoch being set incorrectly when updating validator * move most implementation logic to `validator_pool`, add tests * ensure consistent logging between VC and BN * add docs
2022-12-09 16:05:55 +00:00
- 'doppelganger-detection.md'
4347 fix the REST API navigation typo
2022-11-24 09:21:58 +00:00
- "REST APIs":
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
- 'rest-api.md'
- 'keymanager-api.md'
- Storage:
- 'data-dir.md'
- 'era-store.md'
History pruning (fixes #4419) (#4445) Introduce (optional) pruning of historical data - a pruned node will continue to answer queries for historical data up to `MIN_EPOCHS_FOR_BLOCK_REQUESTS` epochs, or roughly 5 months, capping typical database usage at around 60-70gb. To enable pruning, add `--history=prune` to the command line - on the first start, old data will be cleared (which may take a while) - after that, data is pruned continuously. When pruning an existing database, the database will not shrink - instead, the freed space is recycled as the node continues to run - to free up space, perform a trusted node sync with a fresh database. When switching on archive mode in a pruned node, history is retained from that point onwards. History pruning is scheduled to be enabled by default in a future release. In this PR, `minimal` mode from #4419 is not implemented meaning retention periods for states and blocks are always the same - depending on user demand, a future PR may implement `minimal` as well.
2023-01-07 10:02:15 +00:00
- 'history.md'
Initial public version of the Verifying Web3Signer functionality (#4912) * Allow the list of proved properties for web3signer to be configured * Document the Web3Signer setups (regular, distributed and verified)
2023-05-09 08:16:43 +00:00
- 'web3signer.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'migration-options.md'
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
- 'attestation-performance.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'troubleshooting.md'
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 06:59:55 +00:00
- 'faq.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'developers.md'
- 'resources.md'
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'contribute.md'
- Downloads:
- 'binaries.md'
- 'docker.md'
- 'checksums.md'