docs/how-to-use-docs/documentation-guide.rst

   1 ===================
   2 Documentation Guide
   3 ===================
   4
   5 This page intends to cover the documentation handling for OPNFV. OPNFV projects are expected to create a variety of document types,
   6 according to the nature of the project. Some of these are common to projects that develop/integrate features into the OPNFV platform, e.g.
   7 Installation Instructions and User/Configurations Guides. Other document types may be project-specific.
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 Getting Started with Documentation for Your Project
  14 ---------------------------------------------------
  15 OPNFV documentation is automated and integrated into our git & gerrit toolchains.
  16
  17 We use RST document templates in our repositories and automatically render to HTML and PDF versions of the documents in our artifact
  18 store, our Wiki is also able to integrate these rendered documents directly allowing projects to use the revision controlled documentation
  19 process for project information, content and deliverables.
  20 Read :ref:`this page <include-documentation>` which elaborates on how documentation is to be included within opnfvdocs.
  21
  22 Licencing your documentation
  23 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  24 All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is contributed
  25 in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_  and the `SPDX https://spdx.org/>`_ licence.
  26 All documentation files need to be licensed using the text below. The license may be applied in the first lines of
  27 all contributed RST files:
  28
  29 .. code-block:: bash
  30
  31  .. This work is licensed under a Creative Commons Attribution 4.0 International License.
  32  .. SPDX-License-Identifier: CC-BY-4.0
  33  .. (c) <optionally add copywriters name>
  34
  35  These lines will not be rendered in the html and pdf files.
  36
  37 How and where to store the document content files in your repository
  38 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  39 All documentation for your project should be structured and stored in the :code:`<repo>/docs/` directory. The documentation toolchain will
  40 look in these directories and be triggered on events in these directories when generating documents.
  41
  42 Document structure and contribution
  43 -----------------------------------
  44 A general structure is proposed for storing and handling documents that are common across many projects but also for documents that may be
  45 project specific. The documentation is divided into three areas Release, Development and Testing. Templates for these areas can be found
  46 under :code:`opnfvdocs/docs/templates/`.
  47
  48 Project teams are encouraged to use templates provided by the opnfvdocs project to ensure that there is consistency across the community.
  49 Following representation shows the expected structure:
  50
  51 ::
  52
  53         docs/
  54         ├── development
  55         │   ├── design
  56         │   ├── overview
  57         │   └── requirements
  58         ├── release
  59         │   ├── configguide
  60         │   ├── installation
  61         │   ├── release-notes
  62         │   ├── scenarios
  63         │   │   └── scenario.name
  64         │   └── userguide
  65         ├── testing
  66         │   ├── developer
  67         │   └── user
  68         └── infrastructure
  69             ├── hardware-infrastructure
  70             ├── software-infrastructure
  71             ├── continuous-integration
  72             └── cross-community-continuous-integration
  73
  74 Release documentation
  75 ^^^^^^^^^^^^^^^^^^^^^
  76 Release documentation is the set of documents that are published for each OPNFV release. These documents are created and developed
  77 following the OPNFV release process and milestones and should reflect the content of the OPNFV release.
  78 These documents have a master index.rst file in the <opnfvdocs> repository and extract content from other repositories.
  79 To provide content into these documents place your <content>.rst files in a directory in your repository that matches the master document
  80 and add a reference to that file in the correct place in the corresponding index.rst file in :code:`opnfvdocs/docs/release/`.
  81
  82 **Platform Overview**: :code:`opnfvdocs/docs/release/overview`
  83
  84 - Note this document is not a contribution driven document
  85 - Content for this is prepared by the Marketing team together with the opnfvdocs team
  86
  87 **Installation Instruction**: :code:`<repo>/docs/release/installation`
  88
  89 - Folder for documents describing how to deploy each installer and scenario descriptions
  90 - Release notes will be included here <To Confirm>
  91 - Security related documents will be included here
  92 - Note that this document will be compiled into 'OPNFV Installation Instruction'
  93
  94 **User Guide**: :code:`<repo>/docs/release/userguide`
  95
  96 - Folder for manuals to use specific features
  97 - Folder for documents describing how to install/configure project specific components and features
  98 - Can be the directory where API reference for project specific features are stored
  99 - Note this document will be compiled into 'OPNFV userguide'
 100
 101 **Configuration Guide**: :code:`<repo>/docs/release/configguide`
 102
 103 - Brief introduction to configure OPNFV with its dependencies.
 104
 105 **Release Notes**: :code:`<repo>/docs/release/release-notes`
 106
 107 - Changes brought about in the release cycle.
 108 - Include version details.
 109
 110 Testing documentation
 111 ^^^^^^^^^^^^^^^^^^^^^
 112 Documentation created by test projects can be stored under two different sub directories /user or /developemnt.
 113 Release notes will be stored under <repo>/docs/release/release-notes
 114
 115 **User documentation**: :code:`<repo>/testing/user/`
 116 Will collect the documentation of the test projects allowing the end user to perform testing towards a OPNFV SUT
 117 e.g. Functest/Yardstick/Vsperf/Storperf/Bottlenecks/Qtip installation/config & user guides.
 118
 119 **Development documentation**: :code:`<repo>/testing/developent/`
 120 Will collect documentation to explain how to create your own test case and leverage existing testing frameworks e.g. developer guides.
 121
 122 Development Documentation
 123 ^^^^^^^^^^^^^^^^^^^^^^^^^
 124 Project specific documents such as design documentation, project overview or requirement documentation can be stored under
 125 /docs/development. Links to generated documents will be dislayed under Development Documentaiton section on docs.opnfv.org.
 126 You are encouraged to establish the following basic structure for your project as needed:
 127
 128 **Requirement Documentation**: :code:`<repo>/docs/development/requirements/`
 129
 130 - Folder for your requirement documentation
 131 - For details on requirements projects' structures see the `Requirements Projects <https://wiki.opnfv.org/display/PROJ/Requirements+Projects>`_ page.
 132
 133 **Design Documentation**: :code:`<repo>/docs/development/design`
 134
 135 - Folder for your upstream design documents (blueprints, development proposals, etc..)
 136
 137 **Project overview**: :code:`<repo>/docs/development/overview`
 138
 139 - Folder for any project specific documentation.
 140
 141 Infrastructure Documentation
 142 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 143 Infrastructure documentation can be stored under :code:`<repo>/docs/` folder of
 144 corresponding infrastructure project.