rust/neon
1
0
Fork 0
mirror of https://github.com/neondatabase/neon.git synced 2025-12-23 06:09:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update wording in docs to improve readability (#6607)

Browse Source 
## Problem
 Found typos while reading the docs

## Summary of changes
Fixed the typos found
This commit is contained in:
Clarence
2024-02-04 20:33:38 +01:00
committed by GitHub
parent 9dd69194d4
commit 09519c1773
5 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docker.md
View File

@@ -21,7 +21,7 @@ We build all images after a successful `release` tests run and push automaticall
## Docker Compose example ## Docker Compose example
You can see a [docker compose](https://docs.docker.com/compose/) example to create a neon cluster in [/docker-compose/docker-compose.yml](/docker-compose/docker-compose.yml). It creates the following conatainers. You can see a [docker compose](https://docs.docker.com/compose/) example to create a neon cluster in [/docker-compose/docker-compose.yml](/docker-compose/docker-compose.yml). It creates the following containers.
- pageserver x 1 - pageserver x 1
- safekeeper x 3 - safekeeper x 3
@@ -38,7 +38,7 @@ You can specify version of neon cluster using following environment values.
- TAG: the tag version of [docker image](https://registry.hub.docker.com/r/neondatabase/neon/tags) (default is latest), which is tagged in [CI test](/.github/workflows/build_and_test.yml) - TAG: the tag version of [docker image](https://registry.hub.docker.com/r/neondatabase/neon/tags) (default is latest), which is tagged in [CI test](/.github/workflows/build_and_test.yml)
``` ```
$ cd docker-compose/ $ cd docker-compose/
$ docker-compose down # remove the conainers if exists $ docker-compose down # remove the containers if exists
$ PG_VERSION=15 TAG=2937 docker-compose up --build -d # You can specify the postgres and image version $ PG_VERSION=15 TAG=2937 docker-compose up --build -d # You can specify the postgres and image version
Creating network "dockercompose_default" with the default driver Creating network "dockercompose_default" with the default driver
Creating docker-compose_storage_broker_1 ... done Creating docker-compose_storage_broker_1 ... done

2
docs/pageserver-storage.md
View File

@@ -64,7 +64,7 @@ Storage.
The LayerMap tracks what layers exist in a timeline. The LayerMap tracks what layers exist in a timeline.
Currently, the layer map is just a resizeable array (Vec). On a GetPage@LSN or Currently, the layer map is just a resizable array (Vec). On a GetPage@LSN or
other read request, the layer map scans through the array to find the right layer other read request, the layer map scans through the array to find the right layer
that contains the data for the requested page. The read-code in LayeredTimeline that contains the data for the requested page. The read-code in LayeredTimeline
is aware of the ancestor, and returns data from the ancestor timeline if it's is aware of the ancestor, and returns data from the ancestor timeline if it's

2
docs/pageserver-thread-mgmt.md
View File

@@ -22,7 +22,7 @@ timeline to shutdown. It will also wait for them to finish.
A task registered in the task registry can check if it has been A task registered in the task registry can check if it has been
requested to shut down, by calling `is_shutdown_requested()`. There's requested to shut down, by calling `is_shutdown_requested()`. There's
also a `shudown_watcher()` Future that can be used with `tokio::select!` also a `shutdown_watcher()` Future that can be used with `tokio::select!`
or similar, to wake up on shutdown. or similar, to wake up on shutdown.

2
docs/pageserver-walredo.md
View File

@@ -74,4 +74,4 @@ somewhat wasteful, but because most WAL records only affect one page,
the overhead is acceptable. the overhead is acceptable.
The WAL redo always happens for one particular page. If the WAL record The WAL redo always happens for one particular page. If the WAL record
coantains changes to other pages, they are ignored. contains changes to other pages, they are ignored.

4
docs/synthetic-size.md
View File

@@ -21,7 +21,7 @@ implementation where we keep more data than we would need to, do not
change the synthetic size or incur any costs to the user. change the synthetic size or incur any costs to the user.
The synthetic size is calculated for the whole project. It is not The synthetic size is calculated for the whole project. It is not
straighforward to attribute size to individual branches. See "What is straightforward to attribute size to individual branches. See "What is
the size of an individual branch?" for discussion on those the size of an individual branch?" for discussion on those
difficulties. difficulties.
@@ -248,7 +248,7 @@ and truncate the WAL.
Synthetic size is calculated for the whole project, and includes all Synthetic size is calculated for the whole project, and includes all
branches. There is no such thing as the size of a branch, because it branches. There is no such thing as the size of a branch, because it
is not straighforward to attribute the parts of size to individual is not straightforward to attribute the parts of size to individual
branches. branches.
## Example: attributing size to branches ## Example: attributing size to branches