From 77a8952290d83866429f2b7e14b4ee74b25d6d5d Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Tue, 4 Aug 2015 08:50:46 +0900 Subject: [PATCH] Fix eleven typos on designate documentation restructred => restructured specifaclly => specifically Reserverd => Reserved 2 gerenated => generated Defintion => Definition relavant => relevant occour => occur paramaters => parameters suppied => supplied peform => perform Change-Id: If9d2d8953be8af9e4497425ad1e06ef0ccd74076 Closes-Bug: #1481114 --- README.md | 2 +- doc/source/backends/powerdns.rst | 2 +- doc/source/developer-guidelines.rst | 4 ++-- doc/source/gmr.rst | 2 +- doc/source/howtos/secondary_zones.rst | 2 +- doc/source/production-guidelines.rst | 4 ++-- doc/source/rest/v2/collections.rst | 4 ++-- doc/source/rest/v2/pools.rst | 2 +- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4c0ff251b..ccbafb662 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ python setup.py develop ```` ## Building the documentation -To build the documentation from the restructred text source, do the following: +To build the documentation from the restructured text source, do the following: ```` cd doc pip install -r requirements.txt diff --git a/doc/source/backends/powerdns.rst b/doc/source/backends/powerdns.rst index 3d5201f35..b01cb1992 100644 --- a/doc/source/backends/powerdns.rst +++ b/doc/source/backends/powerdns.rst @@ -60,7 +60,7 @@ You need to configure PowerDNS to use the MySQL backend. .. note:: PowerDNS can connect via socket or host/port. -3. Configure the options for designate-central - specifaclly "connection" to point to your MySQL database:: +3. Configure the options for designate-central - specifically "connection" to point to your MySQL database:: [backend:powerdns] connection = mysql+pymysql://:@:/ diff --git a/doc/source/developer-guidelines.rst b/doc/source/developer-guidelines.rst index fd34cd278..607e55ab7 100644 --- a/doc/source/developer-guidelines.rst +++ b/doc/source/developer-guidelines.rst @@ -20,7 +20,7 @@ IP space will likely trigger search indexers etc to begin crawling. Reserved Domains ---------------- -Reserverd DNS domains are documented here: `IANA Special Use Domain Names`_. +Reserved DNS domains are documented here: `IANA Special Use Domain Names`_. Several common reserved domains: @@ -31,7 +31,7 @@ Several common reserved domains: Reserved IP Space ----------------- -Reserverd IP space is documented here: `IANA IPv4 Special Registry`_, and +Reserved IP space is documented here: `IANA IPv4 Special Registry`_, and `IANA IPv6 Special Registry`_. Several common reserved IP blocks: diff --git a/doc/source/gmr.rst b/doc/source/gmr.rst index b2c6aa392..4bdc3235f 100644 --- a/doc/source/gmr.rst +++ b/doc/source/gmr.rst @@ -4,7 +4,7 @@ Guru Meditation Reports ========================= -A Guru Meditation Reports(GMR) is gerenated by the Designate services when +A Guru Meditation Reports(GMR) is generated by the Designate services when service processes receiving SIGUSR1 signal. The report is a general-purpose debug report for developers and system admins which contains the current state of a running Designate service process. diff --git a/doc/source/howtos/secondary_zones.rst b/doc/source/howtos/secondary_zones.rst index 1a77739c4..0acacd75f 100644 --- a/doc/source/howtos/secondary_zones.rst +++ b/doc/source/howtos/secondary_zones.rst @@ -182,7 +182,7 @@ In both cases the interaction between your master and Designate is handled by the MDNS instance at the Designate side. -Defintion of values: +Definition of values: - *email* set to the value of the *managed_resource_email* option in the *central* section of the Designate configuration. diff --git a/doc/source/production-guidelines.rst b/doc/source/production-guidelines.rst index df1796e4a..0b466eba6 100644 --- a/doc/source/production-guidelines.rst +++ b/doc/source/production-guidelines.rst @@ -4,14 +4,14 @@ Production Guidelines This document aims to provide a location for documented production configurations and considerations. Including common misconfigurations, attack -mitigation techniques, and other relavant tips. +mitigation techniques, and other relevant tips. DNS Zone Squatting ================== Designate's multi-tenant nature allows for any user to create (almost) any zone, which can result in the legitimate owner being unable to create the zone -within Designate. There are several ways this can occour: +within Designate. There are several ways this can occur: 1. The squatter simply creates "example.com." in Designate before the legitimate owner can. diff --git a/doc/source/rest/v2/collections.rst b/doc/source/rest/v2/collections.rst index 220282912..44adb5d69 100644 --- a/doc/source/rest/v2/collections.rst +++ b/doc/source/rest/v2/collections.rst @@ -88,12 +88,12 @@ Pagination and Sorting ---------------------- Pagination is available on all collections and is controlled - using a combination of four optional query paramaters: + using a combination of four optional query parameters: * `marker` - denotes the ID of the last item in the previous list. * `limit` - use to set the maximum number of items per page, use "max" to return the upper limit of results as defined - by the operator. If not suppied, the default per page + by the operator. If not supplied, the default per page limit as defined by the operator will be used. * `sort_key` - sorts the results by the specified attribute diff --git a/doc/source/rest/v2/pools.rst b/doc/source/rest/v2/pools.rst index 08420e552..6e0d430f0 100644 --- a/doc/source/rest/v2/pools.rst +++ b/doc/source/rest/v2/pools.rst @@ -295,7 +295,7 @@ Update Pool This would **replace** the value of the `ns_records` key. - It is a good practice to peform a GET and mutate the result + It is a good practice to perform a GET and mutate the result accordingly. :statuscode 202: Accepted