From 43e2290fdff7cdee598f2abf9f18e8801df94202 Mon Sep 17 00:00:00 2001 From: Mark Pekala Date: Wed, 21 Jun 2023 02:45:56 -0700 Subject: [PATCH] More beginner-friendly introduction (#2712) Attempts to make progress on #2250 by rephrasing existing introduction and making sentences slightly shorter. --- README.rst | 2 +- docs/README.rst | 2 +- docs/index.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index c26daf9a..18be2b49 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ You can find a version of this documentation that is searchable and also easier There are many ways to run high availability with PostgreSQL; for a list, see the `PostgreSQL Documentation `__. -Patroni is a template for you to create your own customized, high-availability solution using Python and - for maximum accessibility - a distributed configuration store like `ZooKeeper `__, `etcd `__, `Consul `__ or `Kubernetes `__. Database engineers, DBAs, DevOps engineers, and SREs who are looking to quickly deploy HA PostgreSQL in the datacenter-or anywhere else-will hopefully find it useful. +Patroni is a template for high availability (HA) PostgreSQL solutions using Python. For maximum accessibility, Patroni supports a variety of distributed configuration stores like `ZooKeeper `__, `etcd `__, `Consul `__ or `Kubernetes `__. Database engineers, DBAs, DevOps engineers, and SREs who are looking to quickly deploy HA PostgreSQL in datacenters — or anywhere else — will hopefully find it useful. We call Patroni a "template" because it is far from being a one-size-fits-all or plug-and-play replication system. It will have its own caveats. Use wisely. diff --git a/docs/README.rst b/docs/README.rst index 8e38c908..4e3e7529 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -4,7 +4,7 @@ Introduction ============ -Patroni originated as a fork of `Governor `__, the project from Compose. It includes plenty of new features. +Patroni is a template for high availability (HA) PostgreSQL solutions using Python. Patroni originated as a fork of `Governor `__, the project from Compose. It includes plenty of new features. For an example of a Docker-based deployment with Patroni, see `Spilo `__, currently in use at Zalando. diff --git a/docs/index.rst b/docs/index.rst index 87bd4fdb..e76ec6d5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ Introduction ============ -Patroni is a template for you to create your own customized, high-availability solution using Python and - for maximum accessibility - a distributed configuration store like `ZooKeeper `__, `etcd `__, `Consul `__ or `Kubernetes `__. Database engineers, DBAs, DevOps engineers, and SREs who are looking to quickly deploy HA PostgreSQL in the datacenter-or anywhere else-will hopefully find it useful. +Patroni is a template for high availability (HA) PostgreSQL solutions using Python. For maximum accessibility, Patroni supports a variety of distributed configuration stores like `ZooKeeper `__, `etcd `__, `Consul `__ or `Kubernetes `__. Database engineers, DBAs, DevOps engineers, and SREs who are looking to quickly deploy HA PostgreSQL in datacenters — or anywhere else — will hopefully find it useful. We call Patroni a "template" because it is far from being a one-size-fits-all or plug-and-play replication system. It will have its own caveats. Use wisely. There are many ways to run high availability with PostgreSQL; for a list, see the `PostgreSQL Documentation `__.