diff options
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/configguide/bottlenecks_definition.rst | 12 | ||||
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst | 27 | ||||
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/images/example.png | 0 | ||||
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/index.rst | 17 | ||||
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst | 19 | ||||
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_vstf_testcase_template.rst | 3 | ||||
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst | 23 | ||||
| -rw-r--r-- | docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst | 3 | ||||
| -rw-r--r-- | docs/etc/conf.py | 34 | ||||
| -rw-r--r-- | docs/etc/opnfv-logo.png | bin | 2829 -> 0 bytes | |||
| -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/slides/bottlenecks_project V1.0.pptx (renamed from docs/bottlenecks_project V1.0.pptx) | bin | 2570577 -> 2570577 bytes |
13 files changed, 104 insertions, 150 deletions
diff --git a/docs/bottlenecks_brahmaputra_docs/configguide/bottlenecks_definition.rst b/docs/bottlenecks_brahmaputra_docs/configguide/bottlenecks_definition.rst new file mode 100644 index 00000000..bed4255d --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/configguide/bottlenecks_definition.rst @@ -0,0 +1,12 @@ +====================== +Bottlenecks Definition +====================== + +chapter 1 #replace this with your own name +=========================================== + +chapter 2 +========= + +chapter N +========= diff --git a/docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst b/docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst new file mode 100644 index 00000000..b46029ca --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst @@ -0,0 +1,27 @@ +============ +Introduction +============ + +**Welcome to bottlenecks' documentation !** + +.. _Bottlenecks: https://wiki.opnfv.org/bottlenecks + +Bottlenecks_ is an OPNFV Project. + +The project's goal is + +The Project's scope is + +The *Bottlenecks* framework is deployed in several OPNFV community labs. It is +installer, infrastructure and application independent. + +.. _Pharos: https://wiki.opnfv.org/pharos + +.. seealso:: Pharos_ for information on OPNFV community labs. + +Contact Bottlenecks +=================== + +Feedback? `Contact us`_ + +.. _Contact us: opnfv-users@lists.opnfv.org diff --git a/docs/bottlenecks_brahmaputra_docs/images/example.png b/docs/bottlenecks_brahmaputra_docs/images/example.png new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/images/example.png diff --git a/docs/bottlenecks_brahmaputra_docs/index.rst b/docs/bottlenecks_brahmaputra_docs/index.rst new file mode 100644 index 00000000..f6be0a41 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/index.rst @@ -0,0 +1,17 @@ +******************** +Bottlenecks Project +******************** + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 5 + + configguide/introduction.rst + configguide/bottlenecks_definition.rst + images/example.png + userguide/rubbos/rubbos_installation.rst + userguide/vstf/vstf_installation.rst + templates/bottlenecks_test_result.rst + templates/bottlenecks_vstf_testcase_template.rst diff --git a/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst new file mode 100644 index 00000000..472bdfd3 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst @@ -0,0 +1,19 @@ +======================== +Bottlenecks Test Report +======================== + + +Scope +===== +This document provides an overview of the results of test cases developed by +the OPNFV Bottlenecks Project, executed on OPNFV community labs. + +OPNFV CI(Continous Integration) system provides automated build, deploy and testing for +the software developed in OPNFV. Unless stated, the reported tests are +automated via Jenkins Jobs. + +Test results are visible in the following dashboard: + +* *Testing dashboard*: uses Mongo DB to store test results and Bitergia for + visualization, which includes the rubbos test result, vstf test result. + diff --git a/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_vstf_testcase_template.rst b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_vstf_testcase_template.rst new file mode 100644 index 00000000..98dd7e09 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_vstf_testcase_template.rst @@ -0,0 +1,3 @@ +================================== +Bottlenecks vstf testcase template +================================== diff --git a/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst b/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst new file mode 100644 index 00000000..0d4284a2 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst @@ -0,0 +1,23 @@ +===================================== +Bottlenecks Rubbos Installation Guide +===================================== + + +Rubbos Introduction +==================== +framework description +to test what? + +Preinstall Packages +==================== +such as gettext + + +How is Rubbos Integrated into Installers +======================================== +1.community CI system +2.local + +Test Result Description +======================= +throughput, bottlenecks point description diff --git a/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst b/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst new file mode 100644 index 00000000..45db9d34 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst @@ -0,0 +1,3 @@ +=================================== +Bottlenecks Vstf Installation Guide +=================================== diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index 945f865e..00000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,34 +0,0 @@ -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Bottlenecks', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV Bottlenecks: NFV platform bottlenecks' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png Binary files differdeleted file mode 100644 index 1519503e..00000000 --- a/docs/etc/opnfv-logo.png +++ /dev/null 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 afcf7581..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 36710b32..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/bottlenecks_project V1.0.pptx b/docs/slides/bottlenecks_project V1.0.pptx Binary files differindex 9584d681..9584d681 100644 --- a/docs/bottlenecks_project V1.0.pptx +++ b/docs/slides/bottlenecks_project V1.0.pptx |
