Update specs template

1. Removed TODO
2. Added useful links
3. Added Table of Contents

Change-Id: I95438e43e09cb16c047d5a4f90ad8473a7d0ebe1
Signed-off-by: Vishal Thapar <vishal.thapar@ericsson.com>

diff --git a/docs/specs/index.rst b/docs/specs/index.rst
index 63ddf95261658bad30843381fdf9c0aed0dc3cee..a2786872fe243603cf8e25f6c02790974ae9cee0 100644 (file)
--- a/docs/specs/index.rst
+++ b/docs/specs/index.rst
@@ -7,6 +7,6 @@ various NetVirt features.
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    Design Specification Template <specs-template>

diff --git a/docs/specs/specs-template.rst b/docs/specs/specs-template.rst
index 11c53683171312c1a523576b32d860cdfef56e58..ebf8579819bd7f4919203f8c9bb0fb1e897b9b34 100644 (file)
--- a/docs/specs/specs-template.rst
+++ b/docs/specs/specs-template.rst
@@ -1,13 +1,15 @@
 ..
- TODO:Copyright? We're using OpenStack one as reference, do we need to retain
- their copyright?
-
  Key points to consider:
   * Use RST format. For help with syntax refer http://sphinx-doc.org/rest.html
+  * Use http://rst.ninjs.org/ a web based WYSIWYG RST editor.
   * For diagrams, you can use http://asciiflow.com to make ascii diagrams.
-  * Read `OpenDaylight Documentation Guide <http://docs.opendaylight.org/en/latest/documentation.html>`__
+  * MUST READ http://docs.opendaylight.org/en/latest/documentation.html and follow guidelines.
   * Use same topic branch name for all patches related to this feature.
   * All sections should be retained, but can be marked None or N.A.
+  * Set depth in ToC as per your doc requirements. Should be at least 2.
+
+.. contents:: Table of Contents
+      :depth: 3
 
 =====================
 Title of the feature
@@ -170,7 +172,7 @@ Add any useful references. Some examples:
 * Links to patches in other projects
 * Links to external documentation
 
-[1] http://docs.opendaylight.org/en/latest/documentation.html
+[1] `OpenDaylight Documentation Guide <http://docs.opendaylight.org/en/latest/documentation.html>`__
 
 [2] https://specs.openstack.org/openstack/nova-specs/specs/kilo/template.html