diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-guide.rst | 82 | ||||
| -rw-r--r-- | docs/how-to-use-docs/include-documentation.rst | 20 |
2 files changed, 66 insertions, 36 deletions
diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst index fe5688a92..fb056d4b8 100644 --- a/docs/how-to-use-docs/documentation-guide.rst +++ b/docs/how-to-use-docs/documentation-guide.rst @@ -2,7 +2,9 @@ Documentation Guide ===================== -This page intends to cover the documentation handling for OPNFV. OPNFV projects are expected to create a variety of document types, according to the nature of the project. Some of these are common to projects that develop/integrate features into the OPNFV platform, e.g. Installation Instructions and User/Configurations Guides. Other document types may be project-specific. +This page intends to cover the documentation handling for OPNFV. OPNFV projects are expected to create a variety of document types, +according to the nature of the project. Some of these are common to projects that develop/integrate features into the OPNFV platform, e.g. +Installation Instructions and User/Configurations Guides. Other document types may be project-specific. .. contents:: :depth: 3 @@ -12,13 +14,17 @@ Getting Started with Documentation for Your Project ---------------------------------------------------- OPNFV documentation is automated and integrated into our git & gerrit toolchains. -We use RST document templates in our repositories and automatically render to HTML and PDF versions of the documents in our artifact store, our WiKi is also able to integrate these rendered documents directly allowing projects to use the revision controlled documentation process for project information, content and deliverables. +We use RST document templates in our repositories and automatically render to HTML and PDF versions of the documents in our artifact +store, our WiKi is also able to integrate these rendered documents directly allowing projects to use the revision controlled documentation +process for project information, content and deliverables. Read :ref:`this page <include-documentation>` which elaborates on how documentation is to be included within opnfvdocs. Licencing your documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is contributed in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ licence. -All documentation files need to be licensed using the creative commons licence. The following example may be applied in the first lines of all contributed RST files: +All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is contributed +in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ licence. +All documentation files need to be licensed using the creative commons licence. The following example may be applied in the first lines of +all contributed RST files: .. code-block:: bash @@ -26,39 +32,54 @@ All documentation files need to be licensed using the creative commons licence. .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -These lines will not be rendered in the html and pdf files. +Or if you want to use the `SPDX https://spdx.org/>`_ Shorthand vs. the Creative Commons URL + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) <optionally add copywriters name> + + These lines will not be rendered in the html and pdf files. How and where to store the document content files in your repository ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -All documentation for your project should be structured and stored in the :code:`<repo>/docs/` directory. The documentation toolchain will look in these directories and be triggered on events in these directories when generating documents. +All documentation for your project should be structured and stored in the :code:`<repo>/docs/` directory. The documentation toolchain will +look in these directories and be triggered on events in these directories when generating documents. Document structure and contribution ------------------------------------- -A general structure is proposed for storing and handling documents that are common across many projects but also for documents that may be project specific. The documentation is divided into three areas Release, Development and Testing. Templates for these areas can be found under :code:`opnfvdocs/docs/templates/`. +A general structure is proposed for storing and handling documents that are common across many projects but also for documents that may be +project specific. The documentation is divided into three areas Release, Development and Testing. Templates for these areas can be found +under :code:`opnfvdocs/docs/templates/`. -Project teams are encouraged to use templates provided by the opnfvdocs project to ensure that there is consistency across the community. Following representation shows the expected structure: +Project teams are encouraged to use templates provided by the opnfvdocs project to ensure that there is consistency across the community. +Following representation shows the expected structure: :: - docs/ - ├── development - │ ├── design - │ ├── overview - │ └── requirements - ├── release - │ ├── configguide - │ ├── installation - │ ├── release-notes - │ ├── scenarios - │ │ └── scenario.name - │ └── userguide - └── testing + docs/ + ├── development + │ ├── design + │ ├── overview + │ └── requirements + ├── release + │ ├── configguide + │ ├── installation + │ ├── release-notes + │ ├── scenarios + │ │ └── scenario.name + │ └── userguide + └── testing + ├── developer + └── user Release documentation ^^^^^^^^^^^^^^^^^^^^^^^^ -Release documentation is the set of documents that are published for each OPNFV release. These documents are created and developed following the OPNFV release process and milestones and should reflect the content of the OPNFV release. -These documents have a master index.rst file in the <opnfvdocs> repository and extract content from other repositories. To provide content into these documents place your <content>.rst files in a directory in your repository that matches the master document and add a reference to that file in the correct place in the corresponding index.rst file in :code:`opnfvdocs/docs/release/`. +Release documentation is the set of documents that are published for each OPNFV release. These documents are created and developed +following the OPNFV release process and milestones and should reflect the content of the OPNFV release. +These documents have a master index.rst file in the <opnfvdocs> repository and extract content from other repositories. +To provide content into these documents place your <content>.rst files in a directory in your repository that matches the master document +and add a reference to that file in the correct place in the corresponding index.rst file in :code:`opnfvdocs/docs/release/`. **Platform Overview**: :code:`opnfvdocs/docs/release/overview` @@ -90,11 +111,21 @@ These documents have a master index.rst file in the <opnfvdocs> repository and e Testing documentation ^^^^^^^^^^^^^^^^^^^^^^^^ -*Structure TBD together with test projects* +Documentation created by test projects can be stored under two different sub directories /user or /developemnt. +Release notes will be stored under <repo>/docs/release/release-notes + +**User documentation**: :code:`<repo>/testing/user/` +Will collect the documentation of the test projects allowing the end user to perform testing towards a OPNFV SUT +e.g. Functest/Yardstick/Vsperf/Storperf/Bottlenecks/Qtip installation/config & user guides. + +**Development documentation**: :code:`<repo>/testing/developent/` +Will collect documentation to explain how to create your own test case and leverage existing testing frameworks e.g. developer guides. Development Documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Documentation not aimed for any specific release such as design documentation, project overview or requirement documentation can be stored under /docs/development. Links to generated documents will be dislayed under Development Documentaiton section on docs.opnfv.org. You are encouraged to establish the following basic structure for your project as needed: +Project specific documents such as design documentation, project overview or requirement documentation can be stored under +/docs/development. Links to generated documents will be dislayed under Development Documentaiton section on docs.opnfv.org. +You are encouraged to establish the following basic structure for your project as needed: **Requirement Documentation**: :code:`<repo>/docs/development/requirements/` @@ -108,4 +139,3 @@ Documentation not aimed for any specific release such as design documentation, p **Project overview**: :code:`<repo>/docs/development/overview` - Folder for any project specific documentation. - diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst index 4cf9f2757..1430b946d 100644 --- a/docs/how-to-use-docs/include-documentation.rst +++ b/docs/how-to-use-docs/include-documentation.rst @@ -1,14 +1,14 @@ .. _include-documentation: -============================= +============================ Including your Documentation -============================= +============================ .. contents:: :depth: 3 :local: 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 @@ -34,7 +34,7 @@ the documentation to the project repository. git review In OPNFVDocs Composite Documentation --------------------------------------- +------------------------------------ In toctree +++++++++++ @@ -70,7 +70,7 @@ it, example: <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 @@ -126,8 +126,8 @@ the opnfvdocs team for review and integration. Be sure to add the project leader of the opnfvdocs project as a reviewer of the change you just pushed in gerrit. -'doc8' Validation --------------------------------------- +'doc8' Validation +----------------- It is recommended that all rst content is validated by `doc8 <https://pypi.python.org/pypi/doc8>`_ standards. To validate your rst files using doc8, install doc8. @@ -143,10 +143,10 @@ doc8 can now be used to check the rst files. Execute as, Testing: Build Documentation Locally ---------------------------------------- +------------------------------------ Composite OPNFVDOCS documentation -+++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++ To build whole documentation under opnfvdocs/, follow these steps: Install virtual environment. @@ -181,7 +181,7 @@ Update submodules, build documentation using tox & then open using any browser. .. note:: Make sure to run `tox -edocs` and not just `tox`. Individual project documentation -+++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++ To test how the documentation renders in HTML, follow these steps: Install virtual environment. |