aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/how-to-use-docs/documentation-example.rst86
-rw-r--r--docs/how-to-use-docs/index.rst30
-rw-r--r--docs/releasenotes/index.rst15
-rw-r--r--docs/releasenotes/moon-release.rst128
4 files changed, 143 insertions, 116 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
deleted file mode 100644
index 81c9f026..00000000
--- a/docs/how-to-use-docs/documentation-example.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-.. these two pipes are to seperate the logo from the first title
-|
-|
-How to create documentation for your OPNFV project
-==================================================
-
-this is the directory structure of the docs/ directory that can be found in the root of your project directory
-
-.. code-block:: bash
-
- ./etc
- ./etc/opnfv-logo.png
- ./etc/conf.py
- ./how-to-use-docs
- ./how-to-use-docs/documentation-example.rst
- ./how-to-use-docs/index.rst
-
-To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
-This index file must refence your other rst files.
-
-* Here is an example index.rst
-
-.. code-block:: bash
-
- Example Documentation table of contents
- =======================================
-
- Contents:
-
- .. toctree::
- :numbered:
- :maxdepth: 4
-
- documentation-example.rst
-
- Indices and tables
- ==================
-
- * :ref:`search`
-
- Revision: _sha1_
-
- Build date: |today|
-
-
-The Sphinx Build
-================
-
-When you push documentation changes to gerrit a jenkins job will create html documentation.
-
-* Verify Jobs
-For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
-
-* Merge jobs
-
-Once you are happy with the look of your documentation you can submit the patchset the merge job will
-copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
-
-Here are some quick examples of how to use rst markup
-
-This is a headline::
-
- here is some code, note that it is indented
-
-links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
-
-* Bulleted Items
-
- **this will be bold**
-
-.. code-block:: bash
-
- echo "Heres is a code block with bash syntax highlighting"
-
-
-Leave these at the bottom of each of your documents they are used internally
-
-Revision: _sha1_
-
-Build date: |today|
diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst
deleted file mode 100644
index 8af7427e..00000000
--- a/docs/how-to-use-docs/index.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. OPNFV Release Engineering documentation, created by
- sphinx-quickstart on Tue Jun 9 19:12:31 2015.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-
-Example Documentation table of contents
-=======================================
-
-Contents:
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- documentation-example.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
-
-Build date: |today|
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
new file mode 100644
index 00000000..83291051
--- /dev/null
+++ b/docs/releasenotes/index.rst
@@ -0,0 +1,15 @@
+******************
+Moon Release Notes
+******************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ moon-release.rst
+
+Revision: _sha1_
+
+:Author: Ruan He (ruan.he@orange.com)
+
+Build date: |today| \ No newline at end of file
diff --git a/docs/releasenotes/moon-release.rst b/docs/releasenotes/moon-release.rst
new file mode 100644
index 00000000..e6181e36
--- /dev/null
+++ b/docs/releasenotes/moon-release.rst
@@ -0,0 +1,128 @@
+=======
+License
+=======
+
+OPNFV Colorado release note for Moon Docs
+(c) by Ruan He (Orange)
+
+OPNFV Colorado release note for Moon Docs
+are licensed under a Creative Commons Attribution 4.0 International License.
+You should have received a copy of the license along with this.
+If not, see <http://creativecommons.org/licenses/by/4.0/>.
+
+=======================================
+OPNFV Colorado1.0 release note for Moon
+=======================================
+
+Abstract
+========
+
+This document provides the release notes for Colorado release of Moon project.
+
+Version history
+===============
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+|2016-09-20 | 0.1.0 | | Colorado release |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+
+
+OPNFV Colorado Release
+======================
+
+Moon provides a security management framework for the OPNFV infrastructure.
+It includes a set of software modules.
+
+The internal software modules are:
+
+ * keystone-moon
+ * keystonemiddleware-moon
+ * moonclient
+ * odl-aaa-moon
+ * tests
+
+The OPNFV projects installs Moon is:
+
+ * Compass4NFV
+
+
+The OPNFV projects tests Moon are:
+
+ * Functest
+ * Yardstick
+
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project** | functest |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/tag** | colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | Colorado base release |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | September 22 2016 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | Colorado base release |
+| | |
++--------------------------------------+--------------------------------------+
+
+Version change
+==============
+
+Feature evolution
+-----------------
+
+This is the first tracked release of Moon
+
+
+Document evolution
+------------------
+
+This is the initial version of the Moon project in OPNFV.
+
+
+Deliverables
+============
+
+Software
+--------
+
+ - keystone-moon: https://git.opnfv.org/cgit/moon/tree/keystone-moon
+
+ - keystonemiddleware-moon: https://git.opnfv.org/cgit/moon/tree/keystonemiddleware-moon
+
+ - moonclient: https://git.opnfv.org/cgit/moon/tree/moonclient
+
+ - odl-aaa-moon: https://git.opnfv.org/cgit/moon/tree/upstream/odl-aaa-moon
+
+ - tests: https://git.opnfv.org/cgit/moon/tree/tests
+
+
+Documents
+---------
+
+ - Install Procedure: http://artifacts.opnfv.org/moon/colorado/docs/installationprocedure/index.html
+
+ - Configuration Guide: http://artifacts.opnfv.org/moon/colorado/docs/configurationguide/index.html
+
+ - User Guide: http://artifacts.opnfv.org/moon/colorado/docs/userguide/index.html
+
+ - Scenarios Notes: http://artifacts.opnfv.org/moon/colorado/docs/colorado_scenarios_os-odl_l2-moon-ha/index.html
+
+
+References
+==========
+
+For more information on the Moon Colorado release, please see:
+
+https://wiki.opnfv.org/display/moon/ \ No newline at end of file