diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 86 | ||||
| -rw-r--r-- | docs/how-to-use-docs/index.rst | 30 | ||||
| -rw-r--r-- | docs/requirements/03-architecture.rst | 2 | ||||
| -rw-r--r-- | docs/requirements/04-gaps.rst | 6 | ||||
| -rw-r--r-- | docs/requirements/glossary.rst | 2 |
5 files changed, 5 insertions, 121 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 afcf758..0000000 --- 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 36710b3..0000000 --- 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/requirements/03-architecture.rst b/docs/requirements/03-architecture.rst index e82dfdc..6123cb8 100644 --- a/docs/requirements/03-architecture.rst +++ b/docs/requirements/03-architecture.rst @@ -22,4 +22,4 @@ This is main part. High level northbound interface specification --------------------------------------------- -What is northbound here? VIM controller?
\ No newline at end of file +What is northbound here? VIM controller? diff --git a/docs/requirements/04-gaps.rst b/docs/requirements/04-gaps.rst index 0ea65c5..1d2cb61 100644 --- a/docs/requirements/04-gaps.rst +++ b/docs/requirements/04-gaps.rst @@ -34,9 +34,9 @@ Hypervisor gaps VM and its resource usage. OpenStack gaps -------------- -Later shoudl be per specific component? (nova, neutron...) +Later should be per specific component? (nova, neutron...) - OpenStack Nova +OpenStack Nova 1. Management system should support dozen of thousands individual hosts. Currently each Edge Host is allocated in individual zone, is this approach scalable? 2. Host is explicitly selected effectively bypassing NOVA scheduler @@ -46,4 +46,4 @@ Deployment gaps 1. Only traffic interfaces are exposed (e.g. no eth0, no USB); SW deployment is different from DC. #. Linux shell shall not be exposed; linux CLI shall be replaced presumable by REST. #. Kernel and Hypervisor are hardened. Only OpenStack agents might be added during deployment. -#. AMT or IPMI shall not be used for SW deployment.
\ No newline at end of file +#. AMT or IPMI shall not be used for SW deployment. diff --git a/docs/requirements/glossary.rst b/docs/requirements/glossary.rst index 90e0038..e2f0a4c 100644 --- a/docs/requirements/glossary.rst +++ b/docs/requirements/glossary.rst @@ -23,4 +23,4 @@ mapping/translating the OPNFV terms to terminology used in other contexts. Network Function Virtualization Infrastructure vE-CPE - Virtual Enterprise-Customer Premises Equipment
\ No newline at end of file + Virtual Enterprise-Customer Premises Equipment |