From 32fd709b34dda98db617e4b579e3a732d0e40ef0 Mon Sep 17 00:00:00 2001 From: Heikki Linnakangas Date: Tue, 9 Aug 2022 06:19:18 +0300 Subject: [PATCH] Fix links to safekeeper protocol docs. (#2188) safekeeper/README_PROTO.md was moved to docs/safekeeper-protocol.md in commit 0b14fdb078, as part of reorganizing the docs into 'mdbook' format. Fixes issue #1475. Thanks to @banks for spotting the outdated references. In addition to fixing the above issue, this patch also fixes other broken links as a result of 0b14fdb078. See https://github.com/neondatabase/neon/pull/2188#pullrequestreview-1055918480. Co-authored-by: Heikki Linnakangas Co-authored-by: Thang Pham --- docs/SUMMARY.md | 2 -- docs/glossary.md | 4 ++-- docs/pageserver-services.md | 4 +--- docs/sourcetree.md | 4 ++-- docs/walservice.md | 4 ++-- pageserver/src/layered_repository.rs | 2 +- 6 files changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index cf29ee3c6a..95ac512ea8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -52,10 +52,8 @@ - [multitenancy.md](./multitenancy.md) — how multitenancy is organized in the pageserver and Zenith CLI. - [settings.md](./settings.md) #FIXME: move these under sourcetree.md -#- [pageserver/README.md](/pageserver/README.md) #- [postgres_ffi/README.md](/libs/postgres_ffi/README.md) #- [test_runner/README.md](/test_runner/README.md) -#- [safekeeper/README.md](/safekeeper/README.md) # RFCs diff --git a/docs/glossary.md b/docs/glossary.md index 7aeae27a39..665596c68d 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -75,7 +75,7 @@ layer's Segment and range of LSNs. There are two kinds of layers, in-memory and on-disk layers. In-memory layers are used to ingest incoming WAL, and provide fast access to the recent page versions. On-disk layers are stored as files on disk, and -are immutable. See pageserver/src/layered_repository/README.md for more. +are immutable. See [pageserver-storage.md](./pageserver-storage.md) for more. ### Layer file (on-disk layer) @@ -111,7 +111,7 @@ PostgreSQL LSNs and functions to monitor them: * `pg_last_wal_replay_lsn ()` - Returns the last write-ahead log location that has been replayed during recovery. If recovery is still in progress this will increase monotonically. [source PostgreSQL documentation](https://www.postgresql.org/docs/devel/functions-admin.html): -Neon safekeeper LSNs. For more check [safekeeper/README_PROTO.md](/safekeeper/README_PROTO.md) +Neon safekeeper LSNs. See [safekeeper protocol section](safekeeper-protocol.md) for more information. * `CommitLSN`: position in WAL confirmed by quorum safekeepers. * `RestartLSN`: position in WAL confirmed by all safekeepers. * `FlushLSN`: part of WAL persisted to the disk by safekeeper. diff --git a/docs/pageserver-services.md b/docs/pageserver-services.md index 4e85413513..07a91f543d 100644 --- a/docs/pageserver-services.md +++ b/docs/pageserver-services.md @@ -68,8 +68,6 @@ There are the following implementations present: * local filesystem — to use in tests mainly * AWS S3 - to use in production -Implementation details are covered in the [backup readme](./src/remote_storage/README.md) and corresponding Rust file docs, parameters documentation can be found at [settings docs](../docs/settings.md). - The backup service is disabled by default and can be enabled to interact with a single remote storage. CLI examples: @@ -118,7 +116,7 @@ implemented by the LayeredRepository object in `layered_repository.rs`. There is only that one implementation of the Repository trait, but it's still a useful abstraction that keeps the interface for the low-level storage functionality clean. The layered -storage format is described in layered_repository/README.md. +storage format is described in [pageserver-storage.md](./pageserver-storage.md). Each repository consists of multiple Timelines. Timeline is a workhorse that accepts page changes from the WAL, and serves diff --git a/docs/sourcetree.md b/docs/sourcetree.md index 05eaa96938..39f7be89a0 100644 --- a/docs/sourcetree.md +++ b/docs/sourcetree.md @@ -28,7 +28,7 @@ The pageserver has a few different duties: - Receive WAL from the WAL service and decode it. - Replay WAL that's applicable to the chunks that the Page Server maintains -For more detailed info, see [/pageserver/README](/pageserver/README.md) +For more detailed info, see [pageserver-services.md](./pageserver-services.md) `/proxy`: @@ -57,7 +57,7 @@ PostgreSQL extension that contains functions needed for testing and debugging. The zenith WAL service that receives WAL from a primary compute nodes and streams it to the pageserver. It acts as a holding area and redistribution center for recently generated WAL. -For more detailed info, see [/safekeeper/README](/safekeeper/README.md) +For more detailed info, see [walservice.md](./walservice.md) `/workspace_hack`: The workspace_hack crate exists only to pin down some dependencies. diff --git a/docs/walservice.md b/docs/walservice.md index 7b217ddbec..4e6db0c5a4 100644 --- a/docs/walservice.md +++ b/docs/walservice.md @@ -75,8 +75,8 @@ safekeepers. The Paxos and crash recovery algorithm ensures that only one primary node can be actively streaming WAL to the quorum of safekeepers. -See README_PROTO.md for a more detailed description of the consensus -protocol. spec/ contains TLA+ specification of it. +See [this section](safekeeper-protocol.md) for a more detailed description of +the consensus protocol. spec/ contains TLA+ specification of it. # Q&A diff --git a/pageserver/src/layered_repository.rs b/pageserver/src/layered_repository.rs index 79a180c4cf..271e62a4f9 100644 --- a/pageserver/src/layered_repository.rs +++ b/pageserver/src/layered_repository.rs @@ -5,7 +5,7 @@ //! get/put call, walking back the timeline branching history as needed. //! //! The files are stored in the .neon/tenants//timelines/ -//! directory. See layered_repository/README for how the files are managed. +//! directory. See docs/pageserver-storage.md for how the files are managed. //! In addition to the layer files, there is a metadata file in the same //! directory that contains information about the timeline, in particular its //! parent timeline, and the last LSN that has been written to disk.