Skip to content

Commit d7997ff

Browse files
Small documentation and user-facing messaging tweaks (#947)
* Fix typos in documentation and user-facing messages * docs: Remove unsupported version The 'pg_autoctl status' command doesn't accept the --monitor option, so remove from the documentation.
1 parent 8a71518 commit d7997ff

8 files changed

Lines changed: 12 additions & 15 deletions

File tree

docs/citus-quickstart.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ failure in the coordinator and worker nodes and see how the system continues
99
to function.
1010

1111
This tutorial uses `docker-compose`__ in order to separate the architecture
12-
design from some of the implementation details. This allows reasonning at
12+
design from some of the implementation details. This allows reasoning at
1313
the architecture level within this tutorial, and better see which software
1414
component needs to be deployed and run on which node.
1515

@@ -192,7 +192,7 @@ actual nodes.
192192
__ https://yaml101.com/anchors-and-aliases/
193193

194194
Also this time we provision an application service (named "app") that sits
195-
in the backgound and allow us to later connect to our current primary
195+
in the background and allow us to later connect to our current primary
196196
coordinator. See :download:`Dockerfile.app <citus/Dockerfile.app>` for the
197197
complete definition of this service.
198198

@@ -254,7 +254,7 @@ Our first Citus worker failover
254254
-------------------------------
255255

256256
We see that in the ``citus_get_active_worker_nodes()`` output we have
257-
``worker1a``, ``worker2b``, and ``worker3a``. As mentionned before, that
257+
``worker1a``, ``worker2b``, and ``worker3a``. As mentioned before, that
258258
should have no impact on the operations of the Citus cluster when nodes are
259259
all dimensionned the same.
260260

docs/ref/pg_autoctl_create_postgres.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ The following options are available to ``pg_autoctl create postgres``:
246246
connections in the Postgres HBA rules.
247247

248248
For instance, when the monitor resolves to ``192.168.0.1`` and your local
249-
Postgres node uses an inferface with IP address
249+
Postgres node uses an interface with IP address
250250
``192.168.0.2/255.255.255.0`` to connect to the monitor, then the LAN CIDR
251251
is computed to be ``192.168.0.0/24``.
252252

docs/ref/pg_autoctl_status.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ Options
2424
--pgdata
2525

2626
Location of the Postgres node being managed locally. Defaults to the
27-
environment variable ``PGDATA``. Use ``--monitor`` to connect to a monitor
28-
from anywhere, rather than the monitor URI used by a local Postgres node
29-
managed with ``pg_autoctl``.
27+
environment variable ``PGDATA``.
3028

3129
--json
3230

@@ -42,8 +40,7 @@ PGDATA
4240

4341
PG_AUTOCTL_MONITOR
4442

45-
Postgres URI to connect to the monitor node, can be used instead of the
46-
``--monitor`` option.
43+
Postgres URI to connect to the monitor node.
4744

4845
XDG_CONFIG_HOME
4946

docs/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ has been used at creation time. That's because the ``host`` records match
327327
either SSL or non-SSL connection attempts in Postgres HBA file, so the
328328
pre-existing setup will continue to work. To enhance the SSL setup, you can
329329
manually edit the HBA files and change the existing lines from ``host`` to
330-
``hostssl`` to dissallow unencrypted connections at the server side.
330+
``hostssl`` to disallow unencrypted connections at the server side.
331331

332332
In summary, to upgrade an existing pg_auto_failover setup to enable SSL:
333333

docs/tutorial.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ standby. Then we'll add a second standby node. We’ll simulate failure in the
88
Postgres nodes and see how the system continues to function.
99

1010
This tutorial uses `docker-compose`__ in order to separate the architecture
11-
design from some of the implementation details. This allows reasonning at
11+
design from some of the implementation details. This allows reasoning at
1212
the architecture level within this tutorial, and better see which software
1313
component needs to be deployed and run on which node.
1414

@@ -202,7 +202,7 @@ Next steps
202202
As mentioned in the first section of this tutorial, the way we use
203203
docker-compose here is not meant to be production ready. It's useful to
204204
understand and play with a distributed system such as Postgres multiple
205-
nodes sytem and failovers.
205+
nodes system and failovers.
206206

207207
See the command :ref:`pg_autoctl_do_tmux_compose_session` for more details
208208
about how to run a docker-compose test environment with docker-compose,

src/bin/lib/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ We utilize the "ini.h" ini-file reader from https://github.com/mattiasgustavsson
2323

2424
## JSON
2525

26-
The parson librairy at https://github.com/kgabis/parson is a single C file
26+
The parson library at https://github.com/kgabis/parson is a single C file
2727
and MIT licenced. It allows parsing from and serializing to JSON.
2828

2929
## pg

src/bin/pg_autoctl/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The code is organized in the following way:
3636
- files with a names that start with `ini_` implement our higher level
3737
facilities to handle configuration written in the INI format.
3838

39-
- files with a names that starts with `pg` implement abstrations used to
39+
- files with a names that starts with `pg` implement abstractions used to
4040
handle a Postgres service:
4141

4242
- the `pgsql` module contains code to query the local Postgres

src/bin/pg_autoctl/cli_create_node.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1476,7 +1476,7 @@ check_hostname(const char *hostname)
14761476

14771477
if (!fetchLocalCIDR(hostname, cidr, BUFSIZE))
14781478
{
1479-
log_warn("Failed to find adress \"%s\" in local network "
1479+
log_warn("Failed to find address \"%s\" in local network "
14801480
"interfaces, automated pg_hba.conf setup might fail.",
14811481
hostname);
14821482
}

0 commit comments

Comments
 (0)