Merge "Reorganised developer documentation"

2017-07-18 11:44:48 +00:00
parent 0e1b9cc22b a764b90f74
commit 9d0b12f64f
10 changed files with 21 additions and 14 deletions
--- a/doc/source/devref/api_change_tutorial.rst
+++ b/doc/source/devref/api_change_tutorial.rst
@@ -11,9 +11,9 @@
      License for the specific language governing permissions and limitations
      under the License.

-===================
-API Change Tutorial
-===================
+====================
+Making an API Change
+====================

 This document will guide you through the process of proposing and submitting
 an API change to keystone.
--- a/doc/source/devref/build-docs.rst
+++ b/doc/source/devref/build-docs.rst
@@ -14,6 +14,7 @@
      License for the specific language governing permissions and limitations
      under the License.

+==========================
 Building the Documentation
 ==========================

--- a/doc/source/devref/caching-layer.rst
+++ b/doc/source/devref/caching-layer.rst
@@ -14,6 +14,7 @@
      License for the specific language governing permissions and limitations
      under the License.

+=============
 Caching Layer
 =============

--- a/doc/source/devref/development_environment.rst
+++ b/doc/source/devref/development_environment.rst
@@ -14,9 +14,9 @@
      License for the specific language governing permissions and limitations
      under the License.

-====================================
-Setting up a Development Environment
-====================================
+==========================
+Setting up the Environment
+==========================

 This document describes getting the source from keystone's `Git Repository`_
 and setting the environment up for development purposes.
--- a/doc/source/devref/doctor-checks.rst
+++ b/doc/source/devref/doctor-checks.rst
@@ -14,6 +14,7 @@
      License for the specific language governing permissions and limitations
      under the License.

+============================
 Developing ``doctor`` checks
 ============================

--- a/doc/source/devref/filtering-responsibilities.rst
+++ b/doc/source/devref/filtering-responsibilities.rst
@@ -14,6 +14,7 @@
      License for the specific language governing permissions and limitations
      under the License.

+==========================================================
 Filtering responsibilities between controllers and drivers
 ==========================================================

--- a/doc/source/devref/index.rst
+++ b/doc/source/devref/index.rst
@@ -26,18 +26,18 @@ Contributor Documentation
   run-keystone.rst
   initialise.rst
   interact.rst
+   development_environment.rst
   build-docs.rst
   release-notes.rst
   testing-keystone.rst
   doctor-checks.rst
+   http-api.rst
+   api_change_tutorial.rst
   database-migrations.rst
-   filtering-responsibilities.rst
-   list-truncation.rst
   id-manage.rst
   translated-responses.rst
   caching-layer.rst
-   development_environment.rst
-   developing_drivers.rst
-   api_change_tutorial.rst
-   http-api.rst
+   filtering-responsibilities.rst
+   list-truncation.rst
   services.rst
+   developing_drivers.rst
--- a/doc/source/devref/list-truncation.rst
+++ b/doc/source/devref/list-truncation.rst
@@ -14,6 +14,7 @@
      License for the specific language governing permissions and limitations
      under the License.

+=================================
 Entity list truncation by drivers
 =================================

--- a/doc/source/devref/release-notes.rst
+++ b/doc/source/devref/release-notes.rst
@@ -14,8 +14,9 @@
      License for the specific language governing permissions and limitations
      under the License.

-Release Notes
-=============
+==========================
+Working with Release Notes
+==========================

 The Keystone team uses `reno
 <https://docs.openstack.org/developer/reno/usage.html>`_ to generate release
--- a/doc/source/devref/testing-keystone.rst
+++ b/doc/source/devref/testing-keystone.rst
@@ -14,6 +14,7 @@
      License for the specific language governing permissions and limitations
      under the License.

+================
 Testing Keystone
 ================