From 179b06885374c63d350589dee186817d71575285 Mon Sep 17 00:00:00 2001
From: MatthewLi <matthew.lijun@huawei.com>
Date: Thu, 10 Dec 2015 23:56:50 -0800
Subject: how to use docs today in OPNFV

JIRA: PARSER-14

please see the documents under /docs directory

Change-Id: I7cae579f40b61baec2b277142689be25ba1ca75f
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
---
 docs/documentation-example.rst | 76 ++++++++++++++++++++++++++++++++++++++++++
 docs/index.rst                 | 24 +++++++++++++
 2 files changed, 100 insertions(+)
 create mode 100644 docs/documentation-example.rst
 create mode 100644 docs/index.rst

(limited to 'docs')

diff --git a/docs/documentation-example.rst b/docs/documentation-example.rst
new file mode 100644
index 0000000..ebd80e4
--- /dev/null
+++ b/docs/documentation-example.rst
@@ -0,0 +1,76 @@
+.. two dots create a comment. please leave this logo at the top of each of your rst files.
+
+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
+
+    ./yourfolder_name1/file_name1.rst
+    ./yourfolder_nameN/file_nameX.rst
+    ./documentation-example.rst
+    ./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/index.rst b/docs/index.rst
new file mode 100644
index 0000000..4e10cf3
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,24 @@
+.. OPNFV Parser documentation, created by
+   sphinx-quickstart.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Example Documentation table of contents
+=======================================
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   documentation-example.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|
-- 
cgit 1.2.3-korg