Skip to content

docs: Fix broken links in implementation index and sharding doc - #6728

Open
imitater-dou wants to merge 1 commit into
graphprotocol:masterfrom
imitater-dou:docs/fix-implementation-and-sharding-links
Open

imitater-dou wants to merge 1 commit into
graphprotocol:masterfrom
imitater-dou:docs/fix-implementation-and-sharding-links

Conversation

@imitater-dou

Copy link
Copy Markdown

Fixes three broken links in the docs:

  • docs/implementation/README.md
    • drops the "Adding support for a new chain" entry — add-chain.md was removed in f593da5 (docs: Remove add-chain.md) but the index entry stayed
    • "Dump Format" pointed at ./dump.md, but the file was added as docs/dump.md (1bd0448), so the link resolves to docs/implementation/dump.md and 404s; changed to ../dump.md
  • docs/sharding.md: the "here" link for ForeignServer::map_primary / map_metadata still points at store/postgres/src/connection_pool.rs. That file was moved under store/postgres/src/pool/ (a6dbe59) and ForeignServer was later split out into pool/foreign_server.rs (5d3d465), which is where both functions are now.

Docs-only, no code changes.

Verify

B=https://github.com/graphprotocol/graph-node/blob/master
# old targets -> 404
curl -s -o /dev/null -w '%{http_code}\n' $B/docs/implementation/add-chain.md
curl -s -o /dev/null -w '%{http_code}\n' $B/docs/implementation/dump.md
curl -s -o /dev/null -w '%{http_code}\n' $B/store/postgres/src/connection_pool.rs
# new targets -> 200
curl -s -o /dev/null -w '%{http_code}\n' $B/docs/dump.md
curl -s -o /dev/null -w '%{http_code}\n' $B/store/postgres/src/pool/foreign_server.rs

# the functions referenced in sharding.md
curl -s https://raw.githubusercontent.com/graphprotocol/graph-node/master/store/postgres/src/pool/foreign_server.rs \
  | grep -nE 'struct ForeignServer|fn map_primary|fn map_metadata'

- docs/implementation/README.md: drop the entry for add-chain.md, which
  was removed in f593da5, and point the dump format entry at
  ../dump.md (the file was added as docs/dump.md in 1bd0448)
- docs/sharding.md: connection_pool.rs was moved under
  store/postgres/src/pool/ (a6dbe59) and ForeignServer now lives in
  pool/foreign_server.rs; link there instead

Signed-off-by: ADou <ikun3.1415927@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant