Skip to content

Commit d230fcd

Browse files
vladdosterJonathan S. Katz
and
Jonathan S. Katz
committed
Update README.md grammar, spelling, and readability
Corrects various aspects of the README in an effort to increase readability. Co-authored-by: Jonathan S. Katz <[email protected]>
1 parent 80fe987 commit d230fcd

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@
99

1010
[PGO](https://github.com/CrunchyData/postgres-operator), the [Postgres Operator](https://github.com/CrunchyData/postgres-operator) from [Crunchy Data](https://www.crunchydata.com), gives you a **declarative Postgres** solution that automatically manages your [PostgreSQL](https://www.postgresql.org) clusters.
1111

12-
Designed for your GitOps workflows, it is [easy to get started](https://access.crunchydata.com/documentation/postgres-operator/v5/quickstart/) with Postgres on Kubernetes with PGO. Within a few moments, you can have a production grade Postgres cluster complete with high availability, disaster recovery, and monitoring, all over secure TLS communications. Even better, PGO lets you easily customize your Postgres cluster to tailor it to your workload!
12+
Designed for your GitOps workflows, it is [easy to get started](https://access.crunchydata.com/documentation/postgres-operator/v5/quickstart/) with Postgres on Kubernetes with PGO. Within a few moments, you can have a production-grade Postgres cluster complete with high availability, disaster recovery, and monitoring, all over secure TLS communications. Even better, PGO lets you easily customize your Postgres cluster to tailor it to your workload!
1313

14-
With conveniences like cloning Postgres clusters to using rolling updates to roll out disruptive changes with minimal downtime, PGO is ready to support your Postgres data at every stage of your release pipeline. Built for resiliency and uptime, PGO will keep your desired Postgres in a desired state so you do not need to worry about it.
14+
With conveniences like cloning Postgres clusters to using rolling updates to roll out disruptive changes with minimal downtime, PGO is ready to support your Postgres data at every stage of your release pipeline. Built for resiliency and uptime, PGO will keep your Postgres cluster in its desired state, so you do not need to worry about it.
1515

1616
PGO is developed with many years of production experience in automating Postgres management on Kubernetes, providing a seamless cloud native Postgres solution to keep your data always available.
1717

1818
# Installation
1919

20-
We recommend following our [Quickstart](https://access.crunchydata.com/documentation/postgres-operator/v5/quickstart/) for how to install and get up and running with PGO, the Postgres Operator from Crunchy Data. However, if you just can't wait to try it out, here are some instructions to get Postgres up and running on Kubernetes:
20+
We recommend following our [Quickstart](https://access.crunchydata.com/documentation/postgres-operator/v5/quickstart/) for how to install and get up and running with PGO, the Postgres Operator from Crunchy Data. However, if you can't wait to try it out, here are some instructions to get Postgres up and running on Kubernetes:
2121

2222
1. [Fork the Postgres Operator examples repository](https://github.com/CrunchyData/postgres-operator-examples/fork) and clone it to your host machine. For example:
2323

24-
```
24+
```sh
2525
YOUR_GITHUB_UN="<your GitHub username>"
2626
git clone --depth 1 "[email protected]:${YOUR_GITHUB_UN}/postgres-operator-examples.git"
2727
cd postgres-operator-examples
@@ -42,7 +42,7 @@ Pods and PostgreSQL configuration!
4242

4343
#### [High Availability][high-availability]
4444

45-
Safe, automated failover backed by a [distributed consensus based high-availability solution][high-availability].
45+
Safe, automated failover backed by a [distributed consensus high availability solution][high-availability].
4646
Uses [Pod Anti-Affinity][k8s-anti-affinity] to help resiliency; you can configure how aggressive this can be!
4747
Failed primaries automatically heal, allowing for faster recovery time.
4848

@@ -52,7 +52,7 @@ Support for [standby PostgreSQL clusters][multiple-cluster] that work both withi
5252

5353
[Backups][backups] and [restores][disaster-recovery] leverage the open source [pgBackRest][] utility and
5454
[includes support for full, incremental, and differential backups as well as efficient delta restores][backups].
55-
Set how long you want your backups retained for. Works great with very large databases!
55+
Set how long you to retain your backups. Works great with very large databases!
5656

5757
#### Security and [TLS][tls]
5858

@@ -83,7 +83,7 @@ Advanced [connection pooling][pool] support using [pgBouncer][].
8383

8484
#### Pod Anti-Affinity, Node Affinity, Pod Tolerations
8585

86-
Have your PostgreSQL clusters deployed to [Kubernetes Nodes][k8s-nodes] of your preference. Set your [pod anti-affinity][k8s-anti-affinity], node affinity, Pod tolerations and more rules to customize your deployment topology!
86+
Have your PostgreSQL clusters deployed to [Kubernetes Nodes][k8s-nodes] of your preference. Set your [pod anti-affinity][k8s-anti-affinity], node affinity, Pod tolerations, and more rules to customize your deployment topology!
8787

8888
#### [Scheduled Backups][backup-management]
8989

@@ -101,7 +101,7 @@ You can also [mix-and-match][backups-multi]: PGO lets you [store backups in mult
101101
PGO makes it easy to fully customize your Postgres cluster to tailor to your workload:
102102

103103
- Choose the resources for your Postgres cluster: [container resources and storage size][resize-cluster]. [Resize at any time][resize-cluster] with minimal disruption.
104-
- Use your own container image repository, including support `imagePullSecrets` and private repositories
104+
- - Use your own container image repository, including support `imagePullSecrets` and private repositories
105105
- [Customize your PostgreSQL configuration][customize-cluster]
106106

107107
#### [Namespaces][k8s-namespaces]
@@ -197,7 +197,7 @@ distributions as well.
197197
# Contributing to the Project
198198

199199
Want to contribute to the PostgreSQL Operator project? Great! We've put together
200-
as set of contributing guidelines that you can review here:
200+
a set of contributing guidelines that you can review here:
201201

202202
- [Contributing Guidelines](CONTRIBUTING.md)
203203

@@ -213,15 +213,15 @@ referencing an issue, please be sure to include the issue in your pull request
213213

214214
## Support
215215

216-
If you believe you have found a bug or have detailed feature request, please open a GitHub issue and follow the guidelines for submitting a bug.
216+
If you believe you have found a bug or have a detailed feature request, please open a GitHub issue and follow the guidelines for submitting a bug.
217217

218218
For general questions or community support, we welcome you to [join the PGO project community mailing list](https://groups.google.com/a/crunchydata.com/forum/#!forum/postgres-operator/join) at [https://groups.google.com/a/crunchydata.com/forum/#!forum/postgres-operator/join](https://groups.google.com/a/crunchydata.com/forum/#!forum/postgres-operator/join) and ask your question there.
219219

220220
For other information, please visit the [Support](https://access.crunchydata.com/documentation/postgres-operator/latest/support/) section of the documentation.
221221

222222
# Documentation
223223

224-
For additional information regarding design, configuration and operation of the
224+
For additional information regarding the design, configuration, and operation of the
225225
PostgreSQL Operator, pleases see the [Official Project Documentation][documentation].
226226

227227
If you are looking for the [nightly builds of the documentation](https://crunchydata.github.io/postgres-operator/latest/), you can view them at:

0 commit comments

Comments
 (0)