Rework developer guide for Neutron

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I5d5a3a56c47568db78f7f841752cacbabe25d0ae
(cherry picked from commit 9e145ac9ec7ea359a392846fae3ea89f7b20ea8d)

diff --git a/docs/developer-guides/neutron-northbound.rst b/docs/developer-guides/neutron-northbound.rst
index b23a76328945e37f8ae0cc1fcc2ad3a5b3c307e5..ae6ef1186f77428059817612286a2b5c0fbe4c83 100644 (file)
--- a/docs/developer-guides/neutron-northbound.rst
+++ b/docs/developer-guides/neutron-northbound.rst
@@ -14,7 +14,7 @@ In the Neutron Northbound project:
 -  Add new YANG model for it under ``neutron/model/src/main/yang`` and
    ``update neutron.yang``
 
--  Add northbound API for it, and neutron-spi
+-  Add northbound API for it, and ``neutron-spi``
 
    -  Implement ``Neutron<New API>Request.java`` and
       ``Neutron<New API>Norhtbound.java`` under
@@ -33,7 +33,7 @@ In the Neutron Northbound project:
 
 -  update
    ``neutron/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronNorthboundRSApplication.java``
-   to wire new northbound api to ``RSApplication``
+   to wire new northbound API to ``RSApplication``
 
 -  Add transcriber, ``Neutron<New API>Interface.java`` under
    ``transcriber/src/main/java/org/opendaylight/neutron/transcriber/``
@@ -49,13 +49,13 @@ In the Neutron Northbound project:
       ``integration/test/src/test/java/org/opendaylight/neutron/e2etest/ITNeutronE2E.java``
       to run a newly added tests.
 
-In OpenStack networking-odl
+In OpenStack ``networking-odl``
 
 -  Add new driver (or plugin) for new API with tests.
 
 In a southbound Neutron Provider
 
--  implement actual backend to realize those new API by listening
+-  implement actual back-end to realize those new API by listening
    related YANG models.
 
 How to write transcriber

diff --git a/docs/developer-guides/neutron-service-developer-guide.rst b/docs/developer-guides/neutron-service-developer-guide.rst
index 13857cd01015cd49aed7947e13a8cceab6a5fc5f..08051541f86e4bbacc0021eef2629844b0f0811f 100644 (file)
--- a/docs/developer-guides/neutron-service-developer-guide.rst
+++ b/docs/developer-guides/neutron-service-developer-guide.rst
@@ -62,7 +62,7 @@ found at
 
 Basically those models are based on OpenStack Neutron API definitions.
 For exact definitions, OpenStack Neutron source code needs to be
-referred as the above documentation doesn’t always cover the necessary
+referred as the above documentation does not always cover the necessary
 details. There is nothing special to utilize those Neutron YANG models.
 The basic procedure will be:
 
@@ -112,10 +112,10 @@ Neutron configuration
 ---------------------
 
 From Boron, new models of configuration for OpenDaylight to tell
-OpenStack neutron/networking-odl its configuration/capability.
+OpenStack Neutron/``networking-odl`` its configuration/capability.
 
-hostconfig
-~~~~~~~~~~
+``hostconfig``
+~~~~~~~~~~~~~~
 
 This is for OpenDaylight to tell per-node configuration to Neutron.
 Especially this is used by pseudo agent port binding heavily.
@@ -138,11 +138,11 @@ In Boron this is experimental. The model definition can be found at
 Each Neutron Service provider has its own feature set. Some support the
 full features of OpenStack, but others support only a subset. With same
 supported Neutron API, some functionality may or may not be supported.
-So there is a need for a way that OpenDaylight can tell networking-odl
-its capability. Thus networking-odl can initialize Neutron properly
+So there is a need for a way that OpenDaylight can tell ``networking-odl``
+its capability. Thus ``networking-odl`` can initialize Neutron properly
 based on reported capability.
 
-Neutorn Logger
+Neutron Logger
 --------------
 
 There is another small Karaf feature, ``odl-neutron-logger``, which logs

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index 30536075873cea5850dc907a90c0102241c8b80f..a511d3797f484e62f85fe47f9f84f813fceaa4b9 100644 (file)
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -104,6 +104,7 @@ stateful
 submodule
 submodules
 subclasses
+subnet
 superclass
 switchponders
 TCP