Add docs folder and 2 doc templates from DOC project
authorXiaohua Zhang <xiaohua.zhang@windriver.com>
Fri, 25 Oct 2019 01:32:32 +0000 (09:32 +0800)
committerXiaohua Zhang <xiaohua.zhang@windriver.com>
Fri, 25 Oct 2019 01:32:32 +0000 (09:32 +0800)
Signed-off-by: Xiaohua Zhang <xiaohua.zhang@windriver.com>
Change-Id: Ieaac0ba7538d7e5a9b05ebf155de3c16dc4cc423

docs/developer-guides.rst [new file with mode: 0644]
docs/release-notes.rst [new file with mode: 0644]

diff --git a/docs/developer-guides.rst b/docs/developer-guides.rst
new file mode 100644 (file)
index 0000000..3084821
--- /dev/null
@@ -0,0 +1,33 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. contents::
+   :depth: 3
+   :local:
+
+Developer-Guides
+==============
+
+
+.. note:
+..   * This section is used to describe what a contributor needs to know in order to work on the componenta
+
+..   * this should be very technical, aimed at people who want to help develop the components
+
+..   * this should be how the component does what it does, not a requirements document of what the component should do
+
+..   * this should contain what language(s) and frameworks are used, with versions
+
+..   * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing
+   
+..   * This note must be removed after content has been added.
+
+
+Processes
+---------
+
+
+
+Actions
+-------
+
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..b0d6530
--- /dev/null
@@ -0,0 +1,165 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+This document provides the release notes for <RELEASE> of <COMPONENT>.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 20XX-XX-XX         | 0.1.0              |                    | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 0.1.1              |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+=======
+
+<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+
+
+
+
+Release Data
+============
+<STATE RELEVANT RELEASE DATA/RECORDS>
+
+<EXAMPLE>:
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | E.g. Arno RC2                        |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | E.g. 2015-04-16                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+
+
+Feature additions
+~~~~~~~~~~~~~~~~~~~~~~~
+<STATE ADDED FEATURES BY REFERENCE TO JIRA>
+
+<EXAMPLE>:
+
+**JIRA BACK-LOG:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Bug corrections
+~~~~~~~~~~~~~~~~~~~~~
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+----------------
+
+Software deliverables
+^^^^^^^^^^^^^^^^^^^^^^^
+
+<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+
+<EXAMPLE>:
+
+Documentation deliverables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+
+<EXAMPLE>:
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+^^^^^^^^^^^^^^^^^^^^
+<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
+
+
+
+Known issues
+^^^^^^^^^^^^^^^
+<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
+
+<EXAMPLE>:
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                     |                                      |
+|                                      |                                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Workarounds
+^^^^^^^^^^^^^^^^^
+
+<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
+
+
+
+
+References
+==========
+<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
+
+
+
+