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/>`_ licence.
  26 All documentation files need to be licensed using the creative commons licence. The following example 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  .. http://creativecommons.org/licenses/by/4.0
  33  .. (c) <optionally add copywriters name>
  34
  35 Or if you want to use the `SPDX https://spdx.org/>`_  Shorthand vs. the Creative Commons URL
  36
  37 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
  38 .. SPDX-License-Identifier: CC-BY-4.0
  39 .. (c) <optionally add copywriters name>
  40
  41  These lines will not be rendered in the html and pdf files.
  42
  43 How and where to store the document content files in your repository
  44 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  45 All documentation for your project should be structured and stored in the :code:`<repo>/docs/` directory. The documentation toolchain will
  46 look in these directories and be triggered on events in these directories when generating documents.
  47
  48 Document structure and contribution
  49 -------------------------------------
  50 A general structure is proposed for storing and handling documents that are common across many projects but also for documents that may be
  51 project specific. The documentation is divided into three areas Release, Development and Testing. Templates for these areas can be found
  52 under :code:`opnfvdocs/docs/templates/`.
  53
  54 Project teams are encouraged to use templates provided by the opnfvdocs project to ensure that there is consistency across the community.
  55 Following representation shows the expected structure:
  56
  57 ::
  58
  59         docs/
  60         ├── development
  61         │   ├── design
  62         │   ├── overview
  63         │   └── requirements
  64         ├── release
  65         │   ├── configguide
  66         │   ├── installation
  67         │   ├── release-notes
  68         │   ├── scenarios
  69         │   │   └── scenario.name
  70         │   └── userguide
  71         └── testing
  72             ├── developer
  73             └── user
  74
  75
  76 Release documentation
  77 ^^^^^^^^^^^^^^^^^^^^^^^^
  78 Release documentation is the set of documents that are published for each OPNFV release. These documents are created and developed
  79 following the OPNFV release process and milestones and should reflect the content of the OPNFV release.
  80 These documents have a master index.rst file in the <opnfvdocs> repository and extract content from other repositories.
  81 To provide content into these documents place your <content>.rst files in a directory in your repository that matches the master document
  82 and add a reference to that file in the correct place in the corresponding index.rst file in :code:`opnfvdocs/docs/release/`.
  83
  84 **Platform Overview**: :code:`opnfvdocs/docs/release/overview`
  85
  86 - Note this document is not a contribution driven document
  87 - Content for this is prepared by the Marketing team together with the opnfvdocs team
  88
  89 **Installation Instruction**: :code:`<repo>/docs/release/installation`
  90
  91 - Folder for documents describing how to deploy each installer and scenario descriptions
  92 - Release notes will be included here <To Confirm>
  93 - Security related documents will be included here
  94 - Note that this document will be compiled into 'OPNFV Installation Instruction'
  95
  96 **User Guide**: :code:`<repo>/docs/release/userguide`
  97
  98 - Folder for manuals to use specific features
  99 - Folder for documents describing how to install/configure project specific components and features
 100 - Can be the directory where API reference for project specific features are stored
 101 - Note this document will be compiled into 'OPNFV userguide'
 102
 103 **Configuration Guide**: :code:`<repo>/docs/release/configguide`
 104
 105 - Brief introduction to configure OPNFV with its dependencies.
 106
 107 **Release Notes**: :code:`<repo>/docs/release/release-notes`
 108
 109 - Changes brought about in the release cycle.
 110 - Include version details.
 111
 112 Testing documentation
 113 ^^^^^^^^^^^^^^^^^^^^^^^^
 114 Documentation created by test projects can be stored under two different sub directories /user or /developemnt.
 115 Release notes will be stored under <repo>/docs/release/release-notes
 116
 117 **User documentation**: :code:`<repo>/testing/user/`
 118 Will collect the documentation of the test projects allowing the end user to perform testing towards a OPNFV SUT
 119 e.g. Functest/Yardstick/Vsperf/Storperf/Bottlenecks/Qtip installation/config & user guides.
 120
 121 **Development documentation**: :code:`<repo>/testing/developent/`
 122 Will collect documentation to explain how to create your own test case and leverage existing testing frameworks e.g. developer guides.
 123
 124 Development Documentation
 125 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 126 Project specific documents such as design documentation, project overview or requirement documentation can be stored under
 127 /docs/development. Links to generated documents will be dislayed under Development Documentaiton section on docs.opnfv.org.
 128 You are encouraged to establish the following basic structure for your project as needed:
 129
 130 **Requirement Documentation**: :code:`<repo>/docs/development/requirements/`
 131
 132 - Folder for your requirement documentation
 133 - For details on requirements projects' structures see the `Requirements Projects <https://wiki.opnfv.org/display/PROJ/Requirements+Projects>`_ page.
 134
 135 **Design Documentation**: :code:`<repo>/docs/development/design`
 136
 137 - Folder for your upstream design documents (blueprints, development proposals, etc..)
 138
 139 **Project overview**: :code:`<repo>/docs/development/overview`
 140
 141 - Folder for any project specific documentation.