diff options
41 files changed, 136 insertions, 579 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5b779af1d..163eb12a1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,8 @@ import sphinx_bootstrap_theme -import subprocess # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -# <! RTD Hack > -subprocess.call(["rm", "-rf", "*"]) -# <!/ RTD Hack > # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -105,7 +101,7 @@ html_theme = 'bootstrap' # documentation. # html_theme_options = {} html_theme_options = { - 'bootswatch_theme': "united", + 'bootswatch_theme': "journal", } # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/development/templates/design/design.rst b/docs/development/templates/design/design.rst deleted file mode 100644 index e69de29bb..000000000 --- a/docs/development/templates/design/design.rst +++ /dev/null diff --git a/docs/development/templates/design/index.rst b/docs/development/templates/design/index.rst deleted file mode 100644 index 817a19440..000000000 --- a/docs/development/templates/design/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -===================== -<feature> Design -===================== - -.. describe which upstream components (e.g. OpenStack modules, ..) are working together to provide the functionality -.. describe some deployment architecture -.. fill the gap between the release notes and the detailed documentation provided by the participating projects or upstream communities - -.. toctree:: - :maxdepth: 2 - - ./design.rst - diff --git a/docs/development/templates/integration/index.rst b/docs/development/templates/integration/index.rst deleted file mode 100644 index 2e7dd06d3..000000000 --- a/docs/development/templates/integration/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -====================== -<feature> Integration -====================== - -Introduction -============== -..Brief on what scenario's the project can be integrated to. - -Integration Steps for <> -=========================== -.. List steps to integrate <project> with <scenario> diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index 8ff73c842..0869149cb 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -153,4 +153,4 @@ Software fast-path quality metrics ../submodules/fastpathmetrics/docs/userguide/index ../submodules/fastpathmetrics/docs/requirements/index - ../submodules/fastpathmetrics/docs/configguide/index
\ No newline at end of file + ../submodules/fastpathmetrics/docs/configguide/index diff --git a/docs/how-to-use-docs/Submodules.jpg b/docs/how-to-use-docs/Submodules.jpg Binary files differnew file mode 100644 index 000000000..aeb7956a3 --- /dev/null +++ b/docs/how-to-use-docs/Submodules.jpg diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst index 8ad1a2753..f1f299e63 100644 --- a/docs/how-to-use-docs/include-documentation.rst +++ b/docs/how-to-use-docs/include-documentation.rst @@ -1,66 +1,127 @@ ============================================= -OPNFV User guide documentation instruction +Including your Documentation ============================================= -Including your Documentation ------------------------------- +.. contents:: + :depth: 3 + :local: -Add your documentation to your repository in the folder structure and according to the template listed above. The documentation template you will require are available in the opnfvdocs repository, you should copy the relevant templates to the /docs/userguide directory in your repository. For instance if I wanted to document enabling my feature set in the platform I would follow an example like: +In your project repository +---------------------------- + +Add your documentation to your repository in the folder structure and +according to the templates listed above. The documentation templates you +will require are available in opnfvdocs/docs/templates/ repository, you should +copy the relevant templates to your <repo>/docs/ directory in your repository. +For instance if you want to document userguide, then your steps shall be +as follows: .. code-block:: bash - mkdir <my_repo>/docs/userguide + git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git - cp opnfvdocs/docs/userguide/userguide.rst <my_repo>/docs/userguide + cp -p opnfvdocs/docs/userguide/* <my_repo>/docs/userguide/ -You should then add the relevant information to the template that will explain the usage of your feature and instructions for validating that the feature was used successfully like checking the results of specific test cases. Be sure to maintain the creative commons license from the template and ensure all your documentation files include the license information. +You should then add the relevant information to the template that will +explain the documentation. When you are done writing, you can commit +the documentation to the project repository. + +.. code-block:: bash + + git add . + git commit --signoff --all + git review -Once your documentation is ready you should ensure they are compiled into the staging files by adding them to the master <section>.rst file in the opnfvdocs repository. The staging files are structured in such a way that you should refer to your document in the correct section of the document structure. +In OPNFVDocs Composite Documentation +-------------------------------------- + +In toctree ++++++++++++ + +To import project documents from project repositories, we use submodules. + Each project is stored in :code:`opnfvdocs/docs/submodule/` as follows: + +.. image:: Submodules.jpg + :scale: 50 % + +To include your project specific documentation in the composite documentation, +first identify where your project documentation should be included. +Say your project userguide should figure in the ‘OPNFV Userguide’, then: -An example of how to add your documentation to the relevant sections of the feature-usage.rst file might be: .. code-block:: bash - git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git - cd opnfvdocs - git review -s - vim docs/userguide/feature-usage.rst ' + vim opnfvdocs/docs/release/userguide.introduction.rst + +This opens the text editor. Identify where you want to add the userguide. +If the userguide is to be added to the toctree, simply include the path to +it, example: -At this point you should add the references to your files into the index.rst file, for instance in the feature description section you would add the line: -The following sections of the user guide provide feature specific usage guidelines and references. -Providing users the necessary information to leveraging the features in the platform, -some operation in this section may refer back to the guides in the general system usage section. .. code-block:: bash -.. include:: ../projects/promise/userguide/userguide.rst -.. include:: ../projects/copper/userguide/userguide.rst Using Brahmaputra Features -.. include:: ../projects/<my_repo>/userguide/userguide.rst'' + .. toctree:: + :maxdepth: 1 + + submodules/functest/docs/userguide/index + submodules/bottlenecks/docs/userguide/index + submodules/yardstick/docs/userguide/index + <submodules/path-to-your-file> + +As Hyperlink ++++++++++++++ + +It's pretty common to want to reference another location in the +OPNFV documentation and it's pretty easy to do with +reStructuredText. This is a quick primer, more information is in the +`Sphinx section on Cross-referencing arbitrary locations +<http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_. + +Within a single document, you can reference another section simply by:: + + This is a reference to `The title of a section`_ + +Assuming that somewhere else in the same file there a is a section +title something like:: + + The title of a section + ^^^^^^^^^^^^^^^^^^^^^^ + +It's typically better to use ``:ref:`` syntax and labels to provide +links as they work across files and are resilient to sections being +renamed. First, you need to create a label something like:: + + .. _a-label: + + The title of a section + ^^^^^^^^^^^^^^^^^^^^^^ + +.. note:: The underscore (_) before the label is required. + +Then you can reference the section anywhere by simply doing:: -If this is the first contribution from your project to the composite document files you will need to add your project to the build-composite.sh file in the opnfvdocs directory. This is done my editing the jsdgf file and adding your repository name to the get_repo_names() function of the script. Assuming you are still in the opnfvdocs directory edit the file with the following command: -' vim build-composite.sh ' + This is a reference to :ref:`a-label` +or:: -Once you have the file open, add your projects repository to the get_repo_names() function: + This is a reference to :ref:`a section I really liked <a-label>` -.. code-block:: python - get_repo_names() { - # NOTE: Not all repositories are ready for the composite docs, - # so we have the repo name list here to add project docs - # one by one. This will be replaced by the list in project.cfg . - # grep -v '^#' releng/jjb/opnfvdocs/project.cfg | sort - echo "sdnvpn" - echo "<my_repo>" +.. note:: When using ``:ref:``-style links, you don't need a trailing + underscore (_). +Because the labels have to be unique, it usually makes sense to prefix +the labels with the project name to help share the label space, e.g., +``sfc-user-guide`` instead of just ``user-guide``. -Once you have made these changes you need to push the patch back to the opnfvdocs team for review and integration. +Once you have made these changes you need to push the patch back to +the opnfvdocs team for review and integration. .. code-block:: bash - ' git add . ' - ' git commit --signoff --all ' - ' git review ' - + git add . + git commit --signoff --all + git review -Be sure to add the project leader of the opnfvdocs project as a reviewer of the change you just pushed in gerrit. Also be aware that once the text is available in the context of the broader release document it may require some revising and editorial work to prepare it for release. +Be sure to add the project leader of the opnfvdocs project +as a reviewer of the change you just pushed in gerrit. diff --git a/docs/index.rst b/docs/index.rst index fb715c539..848b817fe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,3 @@ -.. |date| date:: -.. |time| date:: %H:%M - OPNFV Documentation =================== @@ -10,7 +7,7 @@ system level integration, deployment and testing, OPNFV creates a reference NFV platform to accelerate the transformation of enterprise and service provider networks. Participation is open to anyone, whether you are an employee of a member company or just passionate -about network transformation. This document was generated on |date| at |time|. +about network transformation. Release Documentation ---------------------- @@ -24,15 +21,6 @@ Release Documentation release/subrelease -Developer Documentation ------------------------------------ - -.. toctree:: - :maxdepth: 1 - - featureprojects - - Testing Documentation ------------------------------------- @@ -44,10 +32,10 @@ Testing Documentation submodules/yardstick/docs/userguide/index submodules/vswitchperf/docs/index -.. Commenting the below out until we actually use it -.. Indices and tables -.. ================== -.. -.. * :ref:`genindex` -.. * :ref:`modindex` -.. * :ref:`search`
\ No newline at end of file +Developer Documentation +----------------------------------- + +.. toctree:: + :maxdepth: 1 + + featureprojects diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 201112cad..904c2d66b 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -1,8 +1,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - .. (c) Sofia Wallin Ericsson AB +.. (c) Sofia Wallin Ericsson AB + +==================== +OPNFV Installation +==================== -======== Abstract ======== @@ -14,7 +17,7 @@ integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and JOID. Each installer provides the ability to install a common OPNFV platform as well as integrating additional features delivered through a variety of scenarios by the OPNFV community. -============ + Introduction ============ @@ -29,7 +32,7 @@ An OPNFV installation requires either a physical, or virtual, infrastructure env in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_. When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. -========= + Scenarios ========= @@ -51,7 +54,7 @@ description documents provided: - LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`_ - High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-ha/index.html>`_ -====================== + Installation Procedure ====================== @@ -66,7 +69,7 @@ The instructions for each toolchain can be found in these links: - `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_ - `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_ -===================== + OPNFV Test Frameworks ===================== @@ -85,7 +88,7 @@ Many of the OPNFV test project provide user-guide documentation and installation - `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_ - `Storage Performance Benchmarking for NFVI (StorPerf) user guide <http://artifacts.opnfv.org/storperf/colorado/2.0/docs/userguide/index.html>`_ -============== + Security Notes ============== diff --git a/docs/release/overview.rst b/docs/release/overview.rst index cd1b5d0f9..cc0a30ded 100644 --- a/docs/release/overview.rst +++ b/docs/release/overview.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -============ +=============== +OPNFV Overview +=============== + Introduction ============ @@ -40,7 +43,7 @@ topics (such as the MANO components and applications themselves), OPNFV aims to NFV services by increasing performance and power efficiency improving reliability, availability and serviceability, and delivering comprehensive platform instrumentation. -=========================== + OPNFV Platform Architecture =========================== @@ -176,7 +179,7 @@ This server-either physical or virtual-is first installed with the installation that then installs OpenStack and other components on the controller nodes and compute nodes. See the `OPNFV User Guide`_ for more details. -=========================== + The OPNFV Testing Ecosystem =========================== diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst index eeac29659..ffcb60cf9 100644 --- a/docs/release/subrelease.rst +++ b/docs/release/subrelease.rst @@ -31,4 +31,4 @@ Joid :maxdepth: 1 ../submodules/joid/docs/releasenotes/index - ../submodules/joid/docs/installationprocedure/index
\ No newline at end of file + ../submodules/joid/docs/installationprocedure/index diff --git a/docs/release/templates/installation/<scenario>/<scenario>-installation.rst b/docs/release/templates/installation/<scenario>/<scenario>-installation.rst deleted file mode 100644 index a8cef90ba..000000000 --- a/docs/release/templates/installation/<scenario>/<scenario>-installation.rst +++ /dev/null @@ -1,22 +0,0 @@ -============================================= -<Project Name> <Release Name> Installation -============================================= - - -Preparing for Installation -===================================== -Include any pre configuration, database, or other software downloads -required to install <project>. - -Installing <Feature> -==================================== -Installation toolkit - -Verifying your Installation -==================================== -Describe how to verify the installation. - -Troubleshooting -==================================== -<optional> -Text goes here.
\ No newline at end of file diff --git a/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst b/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst deleted file mode 100644 index f60537566..000000000 --- a/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst +++ /dev/null @@ -1,17 +0,0 @@ -================================================= -<Project Name> <Release Name> Post Installation -================================================= - - -Post Installation Configuration -===================================== -Post Installation Configuration section must include some basic -(must-do) procedures if any, to get started. - -Upgrading From <a Previous Release> -==================================== -Text goes here. - -?Uninstalling? <Feature> -==================================== -Text here. diff --git a/docs/release/templates/installation/<scenario>/index.rst b/docs/release/templates/installation/<scenario>/index.rst deleted file mode 100644 index 053e341d5..000000000 --- a/docs/release/templates/installation/<scenario>/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -=================================== -<Scenario> Installation Guide -=================================== - -.. toctree:: - :maxdepth: 2 - - prerequisite - <scenario>-installation - <scenario>-postinstallation
\ No newline at end of file diff --git a/docs/release/templates/installation/abstract.rst b/docs/release/templates/installation/abstract.rst deleted file mode 100644 index 4868b1a2a..000000000 --- a/docs/release/templates/installation/abstract.rst +++ /dev/null @@ -1,6 +0,0 @@ -============================================= -<Project Name> <Release Name> Abstract -============================================= -.. Example, Joid Danube Abstract - -Abstract explaining the Document
\ No newline at end of file diff --git a/docs/release/templates/installation/compatibility.rst b/docs/release/templates/installation/compatibility.rst deleted file mode 100644 index ffed03042..000000000 --- a/docs/release/templates/installation/compatibility.rst +++ /dev/null @@ -1,18 +0,0 @@ -============================================== -<Project Name> <Release Name> Compatibility -============================================== - - -Compatibility with Previous Releases -======================================= -<optional, required if there's a previous release> -Is it compatible? Did anything about how a user or developer would -consume it change? If so, document it here. - -Migration from Previous Releases -===================================== -<optional, required if there's a previous release for the project> - -Describe any special step somebody would have to take to migrate from a -previous release to this one. If migration isn't supported for some -combinations, state that as well.
\ No newline at end of file diff --git a/docs/release/templates/installation/index.rst b/docs/release/templates/installation/index.rst deleted file mode 100644 index 032f8d40e..000000000 --- a/docs/release/templates/installation/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -=================================== -<Project Name> Installation Guide -=================================== - -Installation Guide -=================== -Refer to https://wiki.opnfv.org/display/DOC/Installation+procedure -Naming Convention is: <Name> <Use Case> <file name>. Eg: Apex Installation Guide Abstract - -.. toctree:: - :maxdepth: 2 - - abstract - prerequisite - supportedscenario - <scenario>/index - compatibility - references
\ No newline at end of file diff --git a/docs/release/templates/installation/prerequisite.rst b/docs/release/templates/installation/prerequisite.rst deleted file mode 100644 index 4f8a0069f..000000000 --- a/docs/release/templates/installation/prerequisite.rst +++ /dev/null @@ -1,15 +0,0 @@ -============================================= -<Project Name> <Release Name> Prerequisite -============================================= - - -Hardware requirement -===================================== -List out the HW requirements - -Software requirement -==================================== -List out the SW requirements - -Configurations -====================================
\ No newline at end of file diff --git a/docs/release/templates/installation/supportedscenario.rst b/docs/release/templates/installation/supportedscenario.rst deleted file mode 100644 index 3d78911f1..000000000 --- a/docs/release/templates/installation/supportedscenario.rst +++ /dev/null @@ -1,13 +0,0 @@ -=================================================== -<Project Name> <Release Name> Supported Scenarios -=================================================== - -<Brief> -========= -Add a short brief about supported scenarios - -.. toctree:: - :maxdepth: 2 - - development/<scenario1>/index - development/<scenario2>/index
\ No newline at end of file diff --git a/docs/release/templates/overview/index.rst b/docs/release/templates/overview/index.rst deleted file mode 100644 index 18e1dbd9d..000000000 --- a/docs/release/templates/overview/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -============================================= -<Project Name> <Release Name> Overview -============================================= - -For example, the title might be "Qtip Danube Overview" - -<Brief (Optional)> -=================== - -.. toctree:: - :maxdepth: 2 - - overview diff --git a/docs/release/templates/overview/overview.rst b/docs/release/templates/overview/overview.rst deleted file mode 100644 index 163cdd3e0..000000000 --- a/docs/release/templates/overview/overview.rst +++ /dev/null @@ -1,13 +0,0 @@ -============================================== -<Project Name> <Release Name> Overview -============================================== - - -Introduction -======================================= -Describing the components and behaviours in a manner that helps people understand the platform and how to work with it - -Upgrades from <Previous Release> -===================================== -<optional, required if there's a previous release for the project> -Describe the new features
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/bugs.rst b/docs/release/templates/releasenotes/bugs.rst deleted file mode 100644 index fbb25dc58..000000000 --- a/docs/release/templates/releasenotes/bugs.rst +++ /dev/null @@ -1,63 +0,0 @@ -============================================= -<Project Name> <Release Name> Bugs -============================================= - - -Resolved Bugs -=============== -List open and resolved bugs if any. - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+ - -Deprecated and Removed Capabilities -===================================== -Provide information about the capabilities that are removed or -deprecated in this release. - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+ - -Known Limitations -===================================== -Provide information about the capabilities that are removed or -deprecated in this release. - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+ - -Open Bugs -===================================== -List any remaining open bugs. Ideally provide a short description and a -link to the entry in JIRA - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/compatibility.rst b/docs/release/templates/releasenotes/compatibility.rst deleted file mode 100644 index ffed03042..000000000 --- a/docs/release/templates/releasenotes/compatibility.rst +++ /dev/null @@ -1,18 +0,0 @@ -============================================== -<Project Name> <Release Name> Compatibility -============================================== - - -Compatibility with Previous Releases -======================================= -<optional, required if there's a previous release> -Is it compatible? Did anything about how a user or developer would -consume it change? If so, document it here. - -Migration from Previous Releases -===================================== -<optional, required if there's a previous release for the project> - -Describe any special step somebody would have to take to migrate from a -previous release to this one. If migration isn't supported for some -combinations, state that as well.
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/deliverables.rst b/docs/release/templates/releasenotes/deliverables.rst deleted file mode 100644 index 25812085a..000000000 --- a/docs/release/templates/releasenotes/deliverables.rst +++ /dev/null @@ -1,12 +0,0 @@ -============================================== -<Project Name> <Release Name> Deliverables -============================================== - - -Software Deliverables -======================================= -List out the software deliverables - -Documentation Deliverables -===================================== -Call out the documentation deliverables
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/index.rst b/docs/release/templates/releasenotes/index.rst deleted file mode 100644 index 9530d803d..000000000 --- a/docs/release/templates/releasenotes/index.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -============================================= -<Project Name> <Release Name> Release Notes -============================================= - -Abstract -=================== -Preface to what this document is about - -License -======= -Include Licensing information here - -Version History -=============== - - -+-------------+-----------+-----------------+----------------------+ -| **Date** | **Ver.** | **Authors** | **Comment** | -| | | | | -+-------------+-----------+-----------------+----------------------+ -| YYYY-MM-DD | X.X.X | Name | Comments | -+-------------+-----------+-----------------+----------------------+ -| YYYY-MM-DD | X.X.X | Name | Comments |+-------------+-----------+-----------------+----------------------+ -| YYYY-MM-DD | X.X.X | Name | Comments | -+-------------+-----------+-----------------+----------------------+ - -Contents -=============== - -.. toctree:: - :maxdepth: 2 - - summary - version - compatibility - bugs - deliverables - scenario/index - references diff --git a/docs/release/templates/releasenotes/newfeatures.rst b/docs/release/templates/releasenotes/newfeatures.rst deleted file mode 100644 index eab36cdca..000000000 --- a/docs/release/templates/releasenotes/newfeatures.rst +++ /dev/null @@ -1,23 +0,0 @@ -============================================= -<Project Name> <Release Name> New Features -============================================= - - -Major Capabilities and Enhancements -===================================== -Provide information about the major capabilities this project provides -in this release. Include those from previous release unless they have -been deprecated or removed (see below). - -New Capabilities and Enhancements -==================================== -Call out the new capabilities and/or enhancements that are present in -this release, but were not present in prior releases. - - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: <XXXXXX> | Brief here | -+--------------------------------------+--------------------------------------+ diff --git a/docs/release/templates/releasenotes/references.rst b/docs/release/templates/releasenotes/references.rst deleted file mode 100644 index 590aeb587..000000000 --- a/docs/release/templates/releasenotes/references.rst +++ /dev/null @@ -1,5 +0,0 @@ -============================================== -<Project Name> <Release Name> References -============================================== - -List references
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/scenario/<scenarioname>.rst b/docs/release/templates/releasenotes/scenario/<scenarioname>.rst deleted file mode 100644 index 47c85ec15..000000000 --- a/docs/release/templates/releasenotes/scenario/<scenarioname>.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - - -============================================= -<Scenario> <Release Name> Release Notes -============================================= - - -Introduction -============ -.. In this section explain the purpose of the scenario and the types of capabilities provided - -Scenario components and composition -=================================== -.. In this section describe the unique components that make up the scenario, -.. what each component provides and why it has been included in order -.. to communicate to the user the capabilities available in this scenario. - -Scenario usage overview -======================= -.. Provide a brief overview on how to use the scenario and the features available to the -.. user. This should be an "introduction" to the userguide document, and explicitly link to it, -.. where the specifics of the features are covered including examples and API's - -Limitations, Issues and Workarounds -=================================== -.. Explain scenario limitations here, this should be at a design level rather than discussing -.. faults or bugs. If the system design only provide some expected functionality then provide -.. some insight at this point. - -References -========== - -For more information on the OPNFV Colorado release, please visit -http://www.opnfv.org/colorado
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/scenario/index.rst b/docs/release/templates/releasenotes/scenario/index.rst deleted file mode 100644 index 7a2cf9bb1..000000000 --- a/docs/release/templates/releasenotes/scenario/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -============================================= -<Release Name> Scenario Release Notes -============================================= - -<Brief (Optional)> -=================== - -.. toctree:: - :maxdepth: 2 - - <scenarioname> diff --git a/docs/release/templates/releasenotes/version.rst b/docs/release/templates/releasenotes/version.rst deleted file mode 100644 index ba552595a..000000000 --- a/docs/release/templates/releasenotes/version.rst +++ /dev/null @@ -1,13 +0,0 @@ -============================================== -<Project Name> <Release Name> Version -============================================== - - -Module version changes -======================== -List module level version changes - - -Document Version Changes -========================== -Changes in documentation
\ No newline at end of file diff --git a/docs/release/templates/scenario/index.rst b/docs/release/templates/scenario/index.rst deleted file mode 100644 index 44605fe7a..000000000 --- a/docs/release/templates/scenario/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -=================================== -<scenario> Overview and Description -=================================== -.. This document will be used to provide a description of the scenario for an end user. -.. You should explain the purpose of the scenario, the types of capabilities provided and -.. the unique components that make up the scenario including how they are used. - -.. toctree:: - :maxdepth: 3 - - ./scenario.description.rst diff --git a/docs/release/templates/scenario/scenario.description.rst b/docs/release/templates/scenario/scenario.description.rst deleted file mode 100644 index 36098fd2f..000000000 --- a/docs/release/templates/scenario/scenario.description.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -Introduction -============ -.. In this section explain the purpose of the scenario and the types of capabilities provided - -Scenario components and composition -=================================== -.. In this section describe the unique components that make up the scenario, -.. what each component provides and why it has been included in order -.. to communicate to the user the capabilities available in this scenario. - -Scenario usage overview -======================= -.. Provide a brief overview on how to use the scenario and the features available to the -.. user. This should be an "introduction" to the userguide document, and explicitly link to it, -.. where the specifics of the features are covered including examples and API's - -Limitations, Issues and Workarounds -=================================== -.. Explain scenario limitations here, this should be at a design level rather than discussing -.. faults or bugs. If the system design only provide some expected functionality then provide -.. some insight at this point. - -References -========== - -For more information on the OPNFV Danube release, please visit -http://www.opnfv.org/danube diff --git a/docs/release/templates/userguide/feature.userguide.rst b/docs/release/templates/userguide/feature.userguide.rst deleted file mode 100644 index 517f93d2f..000000000 --- a/docs/release/templates/userguide/feature.userguide.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -<Feature> description -===================== -.. Describe the specific features and how it is realised in the scenario in a brief manner -.. to ensure the user understand the context for the user guide instructions to follow. - -<Feature> capabilities and usage -================================ -.. Describe the specific capabilities and usage for <XYZ> feature. -.. Provide enough information that a user will be able to operate the feature on a deployed scenario. - -<Feature and API usage guidelines and example> ------------------------------------------------ -.. Describe with examples how to use specific features, provide API examples and details required to -.. operate the feature on the platform. diff --git a/docs/release/templates/userguide/index.rst b/docs/release/templates/userguide/index.rst deleted file mode 100644 index 820155fdf..000000000 --- a/docs/release/templates/userguide/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -===================== -<feature> User Guide -===================== - -.. The feature user guide should provide an OPNFV user with enough information to -.. use the features provided by the feature project in the supported scenarios. -.. This guide should walk a user through the usage of the features once a scenario -.. has been deployed and is active according to the installation guide provided -.. by the installer project. - -.. toctree:: - :maxdepth: 2 - -.. The feature.userguide.rst file should contain the text for this document -.. additional documents can be added to this directory and added in the right order -.. to this file as a list below. - - ./feature.userguide.rst - diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 48112e78e..27a012802 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Sofia Wallin (sofia.wallin@ericssion.com) -======== +================ +OPNFV Userguide +================ + Abstract ======== @@ -16,7 +19,7 @@ This document is not intended to replace or replicate documentation from other open source projects such as OpenStack or OpenDaylight, rather highlight the features and capabilities delivered through the OPNFV project. -============ + Introduction ============ @@ -32,7 +35,7 @@ scenario will include different source components or configurations. Scenarios are designed to enable specific features and capabilities in the platform that can be leveraged by the OPNFV user community. -================ + Feature Overview ================ diff --git a/docs/templates/development/design/index.rst b/docs/templates/development/design/index.rst new file mode 100644 index 000000000..392b39f48 --- /dev/null +++ b/docs/templates/development/design/index.rst @@ -0,0 +1 @@ +.. To be decided diff --git a/docs/templates/developer/overview/index.rst b/docs/templates/development/overview/index.rst index caf4dfc70..caf4dfc70 100644 --- a/docs/templates/developer/overview/index.rst +++ b/docs/templates/development/overview/index.rst diff --git a/docs/templates/developer/overview/overview.rst b/docs/templates/development/overview/overview.rst index 498dc0662..498dc0662 100644 --- a/docs/templates/developer/overview/overview.rst +++ b/docs/templates/development/overview/overview.rst diff --git a/docs/templates/development/requirements/index.rst b/docs/templates/development/requirements/index.rst new file mode 100644 index 000000000..392b39f48 --- /dev/null +++ b/docs/templates/development/requirements/index.rst @@ -0,0 +1 @@ +.. To be decided diff --git a/docs/templates/release/configguide/postinstall.rst b/docs/templates/release/configguide/postinstall.rst index 51981a124..daca1ff51 100644 --- a/docs/templates/release/configguide/postinstall.rst +++ b/docs/templates/release/configguide/postinstall.rst @@ -13,7 +13,7 @@ according to this specific installer or feature. :local: Automated post installation activities --------------------------------------- +---------------------------------------- Describe specific post installation activities performed by the OPNFV deployment pipeline including testing activities and reports. Refer to the relevant testing guides, results, and release notes. @@ -24,7 +24,7 @@ case yet so each deploy tool will need to provide (hopefully very simillar) documentation of this. <Project> post configuration procedures --------------------------------------- +----------------------------------------- Describe any deploy tool or feature specific scripts, tests or procedures that should be carried out on the deployment post install and configuration in this section. diff --git a/docs/templates/testing/index.rst b/docs/templates/testing/index.rst new file mode 100644 index 000000000..392b39f48 --- /dev/null +++ b/docs/templates/testing/index.rst @@ -0,0 +1 @@ +.. To be decided |
