From 2ee5357f0880641e82a4d5db5d73099a626a3cdf Mon Sep 17 00:00:00 2001 From: Kieran Spear Date: Fri, 3 Jan 2014 15:21:46 +1100 Subject: [PATCH] Docs spelling/capitalization fixes Change-Id: I3c1dd09b0673906b635f83ded8565d88581cb3a9 --- doc/source/architecture.rst | 10 +++++----- doc/source/backends.rst | 4 ++-- doc/source/backends/bind9.rst | 4 ++-- doc/source/glossary.rst | 4 ++-- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index a7c2ef9e..87f9e13f 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -29,15 +29,15 @@ High Level Topology Designate API ----------------------- -designate-api provides the standard OpenStack style REST api service, accepting http requests, validating authentication tokens with Keystone & passing them to the :ref:`designate-central` service over AMQP. Multiple versions of the api can be hosted, as well as api-extensions, allowing for pluggable extensions to the core api. +designate-api provides the standard OpenStack style REST API service, accepting HTTP requests, validating authentication tokens with Keystone & passing them to the :ref:`designate-central` service over AMQP. Multiple versions of the API can be hosted, as well as API extensions, allowing for pluggable extensions to the core API. -Although designate-api is capable of handling https traffic, it's typical to terminate https elsewhere, e.g. by placing nginx infront of designate-api or by letting the the external facing load balancers terminate https. +Although designate-api is capable of handling HTTPS traffic, it's typical to terminate HTTPS elsewhere, e.g. by placing nginx in front of designate-api or by letting the the external facing load balancers terminate HTTPS. .. _designate-central: Designate Central ----------------------- -designate-central is the service that handles RPC requests via the MQ, it coordinates the persistant storage of data & manipulating backend DNS servers via backends or agents. storage is provided via plugins, typically SQLAlchemy, although MongoDB or other storage drivers should be possible. +designate-central is the service that handles RPC requests via the MQ, it coordinates the persistent storage of data & manipulating backend DNS servers via backends or agents. Storage is provided via plugins, typically SQLAlchemy, although MongoDB or other storage drivers should be possible. .. _designate-sink: @@ -51,7 +51,7 @@ The current sink implementations generate simple forward lookup A records, using DNS Backend ----------------------- -backends are drivers for a particular DNS server. +Backends are drivers for a particular DNS server. Designate supports multiple backend implementations, PowerDNS, BIND, MySQL BIND and dnsmasq, you are also free to implement your own backend to fit your needs, as well as extensions to provide extra functionality to complement existing backends. .. _designate-agent: @@ -70,4 +70,4 @@ Designate uses oslo.rpc for messaging between components, therefore it inherits Database/Storage ----------------------- -storage drivers are drivers for a particular SQL/NoSQL server, designate needs a SQLAlchemy supported storage engine for the persistent storage of data, the recommended driver is MySQL. +Storage drivers are drivers for a particular SQL/NoSQL server. Designate needs a SQLAlchemy-supported storage engine for the persistent storage of data. The recommended driver is MySQL. diff --git a/doc/source/backends.rst b/doc/source/backends.rst index cf286a1e..7ff34409 100644 --- a/doc/source/backends.rst +++ b/doc/source/backends.rst @@ -13,8 +13,8 @@ License for the specific language governing permissions and limitations under the License. -Backend Documenation -==================== +Backend Documentation +===================== Contents: diff --git a/doc/source/backends/bind9.rst b/doc/source/backends/bind9.rst index 5728d142..792fe2fc 100644 --- a/doc/source/backends/bind9.rst +++ b/doc/source/backends/bind9.rst @@ -18,7 +18,7 @@ BIND9 Backend .. note:: The BIND9 backend, while functional, is lacking a solid process for - distributing zonefiles among multiple DNS servers. The soon to be introduced + distributing zone files among multiple DNS servers. The soon to be introduced concept of "Pools" will provide a foundation to fix this. Designate Configuration @@ -44,7 +44,7 @@ Include the Designate generated configuration in /etc/bind/named.conf.local:: include "/var/lib/designate/bind9/zones.config"; Ensure BIND9 can access the above config, one way to achieve this is by -disabling AppArmour:: +disabling AppArmor:: $ touch /etc/apparmor.d/disable/usr.sbin.named $ service apparmor reload diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index 1d6f9ab7..2af5b7de 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -28,7 +28,7 @@ Glossary central Software service running on a central management node that stores - information persistantly in a backend storage using a configurable driver + information persistently in a backend storage using a configurable driver like SQLAlchemy or other. api @@ -38,7 +38,7 @@ Glossary A message queue, typically something like RabbitMQ or ZeroMQ storage - A backend for storing data/information persistantly. Typically MongoDB or + A backend for storing data/information persistently. Typically MongoDB or a SQL based server software. node