Rework node operator docs#2194
Open
palango wants to merge 6 commits into
Open
Conversation
Extract archive-node, run-from-source, network-config, and troubleshooting into their own pages; slim run-node to the Docker full-node quickstart. Rewrite the operator overview and regroup the nav into Node Operation / Node Management / Reference. Add op-geth deprecation framing pointing at the op-geth End of Support notice. Repoint inbound anchor links to the moved sections.
The extracted from-source page was just a pointer to the compose repo with no real build steps. Move that pointer into run-node and remove the page and its nav entry.
Phase 2: new grounded reference pages built from celo-l2-node-docker-compose main (op-geth). configuration.mdx documents the .env vars, ports, and key client flags; monitoring.mdx covers the MONITORING_ENABLED stack and the metrics to watch. Expand troubleshooting with sync-progress and no-peers diagnostics. Wire both pages into the nav and overview map.
op-node's upstream default flipped geth->reth, but the Celo fork keeps geth while op-geth is the bundled execution client (celo-org/optimism#453, held). Document the flag in configuration.mdx with that guidance.
public-rpc-node.mdx covers operating a public JSON-RPC endpoint (--history.transactions, --rollup.sequencerhttp, exposure notes) and cross-links the Community RPC rewards program. maintenance.mdx covers upgrading clients, safe restart/stop, datadir backup, and re-sync options, grounded in the compose README. Snapshot-restore omitted (no published snapshot source). Wire both into nav and the overview map.
- Move 7 superseded notices into infra-partners/notices/archive/, keeping the op-geth and Req/Res CL sync deprecations active - Add Network Notices overview page and nest archived notices under an Archive group in the nav - Add forwarding redirects for archived paths; repoint inbound links and cel2 redirects directly at the archive - Minor operator-doc cleanups (run-node, migrate-node, specs, architecture)
palango
requested review from
karlb,
katen0ra and
piersy
and removed request for
a team
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Part of https://github.com/celo-org/celo-blockchain-planning/issues/1392