Skip to content

Commit d75de2c

Browse files
committed
docs: fixed spellcheck
Signed-off-by: Gabriele Bartolini <[email protected]>
1 parent 95fb206 commit d75de2c

File tree

4 files changed

+30
-6
lines changed

4 files changed

+30
-6
lines changed

.wordlist.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ BarmanObjectStore
33
BarmanObjectStoreConfiguration
44
BarmanObjectStores
55
CloudNativePG
6+
CRD
7+
DataBackupConfiguration
68
Docusaurus
79
EnvVar
810
Gi
@@ -14,12 +16,15 @@ ObjectStore
1416
ObjectStoreSpec
1517
ObjectStoreStatus
1618
PITR
19+
PoR
1720
README
1821
RecoveryWindow
1922
RetentionPolicy
2023
ServerRecoveryWindow
24+
SPDX
2125
TLS
2226
TODO
27+
WALBackupConfiguration
2328
WAL
2429
WALs
2530
api
@@ -29,6 +34,7 @@ auth
2934
backends
3035
barmanObjectName
3136
barmancloud
37+
bzip
3238
cd
3339
cloudnative
3440
clusterrole
@@ -42,6 +48,7 @@ devel
4248
externalClusters
4349
gcs
4450
gf
51+
gzip
4552
github
4653
hostpath
4754
http
@@ -66,6 +73,7 @@ rc
6673
recoverability
6774
repos
6875
retentionCheckInterval
76+
retentionPolicy
6977
rolebinding
7078
sc
7179
selfsigned

web/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
This website is built using [Docusaurus](https://docusaurus.io/), a modern
44
static website generator.
55

6+
### Requirements
7+
8+
- Docker
9+
- [Yarn](https://yarnpkg.com/)
10+
- [Dagger](https://dagger.io/)
11+
- [Task](https://taskfile.dev/)
12+
613
### Installation
714

815
```shell
@@ -35,6 +42,14 @@ $ yarn serve
3542

3643
By default, this will load your site at http://localhost:3000/.
3744

45+
### Spellchecking
46+
47+
From the top directory:
48+
49+
```shell
50+
task spellcheck
51+
```
52+
3853
### Versioning
3954

4055
Docusaurus allows versioning of the documentation to maintain separate sets of

web/docs/backup.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ object storage system. It allows you to configure:
2222
server-side encryption—under `.spec.configuration.wal`
2323
- **Base backup options**—with similar settings for compression, concurrency,
2424
and encryption—under `.spec.configuration.data`
25-
- **Retention policies** to manage the lifecycle of archived WALs and backups
25+
- **Retention policies** to manage the life-cycle of archived WALs and backups
2626
via `.spec.configuration.retentionPolicy`
2727

2828
:::tip
@@ -34,14 +34,15 @@ WAL files are archived in the `wals` directory, while base backups are stored
3434
as **tarballs** in the `base` directory, following the
3535
[Barman Cloud convention](https://docs.pgbarman.org/cloud/latest/usage/#object-store-layout).
3636

37-
The plugin integrates seamlessly with CloudNativePG’s `Backup` and
37+
The plugin integrates seamlessly with CloudNativePG and its `Backup` and
3838
`ScheduledBackup` resources, supporting backups from both primary and
3939
[standby instances](https://cloudnative-pg.io/documentation/current/backup/#backup-from-a-standby)
40-
—including designated primaries in [replica cluster topologies](https://cloudnative-pg.io/documentation/current/replica_cluster/).
40+
—including designated primaries in a distributed topology with
41+
[replica clusters](https://cloudnative-pg.io/documentation/current/replica_cluster/).
4142

4243
## About Barman Cloud
4344

44-
Instead of relying on a traditional, centralised Barman server, the plugin
45+
Instead of relying on a traditional, centralized Barman server, the plugin
4546
orchestrates backup operations directly within the Kubernetes cluster using the
4647
following tools from the [`barman-cloud`](https://pgbarman.org) suite:
4748

@@ -122,7 +123,7 @@ For a deeper comparison, see the [Barman GitHub benchmark discussion](https://gi
122123

123124
## Backup Object Tagging
124125

125-
You can tag backup artefacts (base backups, WAL files, history files) using
126+
You can tag backup artifacts (base backups, WAL files, history files) using
126127
key-value metadata through the following fields in `.spec.configuration`:
127128

128129
- `tags`: tags for base backups and WALs

web/docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: "Introduction"
66
# Barman Cloud Plugin
77

88
The **Barman Cloud Plugin** for [CloudNativePG](https://cloudnative-pg.io/)
9-
enables onlinecontinuous physical backups of PostgreSQL clusters to object storage
9+
enables online continuous physical backups of PostgreSQL clusters to object storage
1010
using the `barman-cloud` suite from the [Barman](https://docs.pgbarman.org/release/latest/)
1111
project.
1212

0 commit comments

Comments
 (0)