..
- 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
=====================
-[link to gerrit patch]
+[gerrit filter: https://git.opendaylight.org/gerrit/#/q/topic:cool-topic]
Brief introduction of the feature.
-
-
Problem description
===================
-
Detailed description of the problem being solved by this feature
Use Cases
---------
-
Use cases addressed by this feature.
Proposed change
===============
-
Details of the proposed change.
Pipeline changes
------------
This should detail any changes to yang models.
+.. code-block:: none
+ :caption: example.yang
+
+ module example {
+ namespace "urn:opendaylight:netvirt:example";
+ prefix "example";
+
+ import ietf-yang-types {prefix yang; revision-date "2013-07-15";}
+
+ description "An example YANG model.";
+
+ revision 2017-02-14 { description "Initial revision"; }
+ }
+
Configuration impact
----------------------
+--------------------
Any configuration parameters being added/deprecated for this feature?
What will be defaults for these? How will it impact existing deployments?
Does it help improve scale and performance or make it worse?
Targeted Release
------------------
+----------------
What release is this feature targeted for?
Alternatives
---
Any CLI if being added.
-
Implementation
==============
Assignee(s)
-----------
Who is implementing this feature? In case of multiple authors, designate a
-primary assigne and other contributors.
+primary assignee and other contributors.
Primary assignee:
- <developer-a>
+ <developer-a>, <irc nick>, <email>
Other contributors:
- <developer-b>
- <developer-c>
-
+ <developer-b>, <irc nick>, <email>
+ <developer-c>, <irc nick>, <email>
Work Items
----------
-Break up work into individual items. This should be a checklist on
-Trello card for this feature. Give link to trello card or duplicate it.
-
+Break up work into individual items. This should be a checklist on a
+Trello card for this feature. Provide the link to the trello card or duplicate it.
Dependencies
============
Any dependencies being added/removed? Dependencies here refers to internal
-[other ODL projects] as well as external [OVS, karaf, JDK etc.] This should
+[other ODL projects] as well as external [OVS, karaf, JDK etc]. This should
also capture specific versions if any of these dependencies.
e.g. OVS version, Linux kernel version, JDK etc.
-This should also capture impacts on existing project that depend on Netvirt.
+This should also capture impacts on existing projects that depend on Netvirt.
Following projects currently depend on Netvirt:
Unimgr
Documentation Impact
====================
-What is impact on documentation for this change? If documentation
-change is needed call out one of the <contributors> who will work with
-Project Documentation Lead to get the changes done.
+What is the impact on documentation for this change? If documentation
+changes are needed call out one of the <contributors> who will work with
+the Project Documentation Lead to get the changes done.
Don't repeat details already discussed but do reference and call them out.
* 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
This work is licensed under a Creative Commons Attribution 3.0 Unported License.
http://creativecommons.org/licenses/by/3.0/legalcode
-
Code Review / netvirt.git / blobdiff