docs/guides/onap-developer/how-to-use-docs/introduction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5 Introduction
   6 ============
   7 This guide describes how to create documentation for the Open Network
   8 Automation Platform (ONAP).  ONAP projects create a variety of
   9 content depending on the nature of the project.  For example projects
  10 delivering a platform component may have different types of content than
  11 a project that creates libraries for a software development kit.
  12 The content from each project may be used together as a reference for
  13 that project and/or be used in documents that are tailored to a specific
  14 user audience and tasks they are performing.
  15
  16 Much of the content in this document is derived from similar
  17 documentation processes used in other Linux Foundation
  18 Projects including OPNFV and Open Daylight.
  19
  20 When is documentation required?
  21 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 All ONAP project contributions should have corresponding documentation.
  23 This includes all new features and changes to features that impact users.
  24
  25 How do I create ONAP documentation?
  26 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  27 ONAP documentation is written in ReStructuredText_ (an easy-to-read,
  28 what-you-see-is-what-you-get, plain text markup syntax).  The process for
  29 creating ONAP documentation and what documents are required are
  30 described in later sections of this Developer Documentation Guide.
  31
  32 .. _ReStructuredText: http://docutils.sourceforge.net/rst.html
  33
  34 Why reStructuredText/Sphinx?
  35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  36
  37 In the past, standard documentation methods included ad-hoc Word documents,
  38 PDFs, poorly organized Wikis, and other, often closed, tools like
  39 Adobe FrameMaker.  The rise of DevOps, Agile, and Continuous Integration,
  40 however, created a paradigm shift for those who care about documentation
  41 because:
  42
  43 1. Documentation must be tightly coupled with code/product releases.
  44    In many cases, particularly with open-source products, many different
  45    versions of the same code can be installed in various production
  46    environments. DevOps personnel must have access to the correct version
  47    of documentation.
  48
  49 2. Resources are often tight, volunteers scarce. With a large software base
  50    like ONAP, a small team of technical writers, even if they are also
  51    developers, cannot keep up with a constantly changing, large code base.
  52    Therefore, those closest to the code should document it as best they can,
  53    and let professional writers edit for style, grammar, and consistency.
  54
  55 Plain-text formatting syntaxes, such as reStructuredText, Markdown,
  56 and Textile, are a good choice for documentation because:
  57
  58 a. They are editor agnostic
  59
  60 b. The source is nearly as easy to read as the rendered text
  61
  62 c. Documentation can be treated exactly as source code is (e.g. versioned,
  63    diff'ed, associated with commit messages that can be included
  64    in rendered docs)
  65
  66 d. Shallow learning curve
  67
  68 The documentation team chose reStructuredText largely because of Sphinx,
  69 a Python-based documentation build system, which uses reStructuredText
  70 natively. In a code base as large as ONAP's, cross-referencing between
  71 component documentation was deemed critical. Sphinx and reStructuredText
  72 have built-in functionality that makes collating and cross-referencing
  73 component documentation easier.
  74
  75 Which docs should go where?
  76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  77
  78 Frequently, developers ask where documentation should be created. Should
  79 they always use reStructuredText/Sphinx? Not necessarily. Is the wiki
  80 appropriate for anything at all? Yes.
  81
  82 It's really up to the development team. Here is a simple rule:
  83
  84 The more tightly coupled the documentation is to a particular version
  85 of the code, the more likely it is that it should be stored with the
  86 code in reStructuredText.
  87
  88 The doc team encourages component teams to store as much documentation
  89 as reStructuredText as possible because:
  90
  91 1. It is easier to edit component documentation for grammar,
  92    spelling, clarity, and consistency.
  93
  94 2. A consistent formatting syntax across components will allow
  95    flexibility in producing different kinds of output.
  96
  97 3. It is easier to re-organize the documentation.
  98
  99 4. Wiki articles tend to grow in size and not maintained making it hard
 100    to find current information.
 101
 102 Structure
 103 ---------
 104 A top level master document structure is used to organize all
 105 documents created by ONAP projects and this resides in the gerrit doc
 106 repository.  Complete documents or guides may reside here and
 107 reference parts of source for documentation from other project
 108 repositories.  Other ONAP projects will provide content that
 109 is referenced from this structure.
 110
 111 ::
 112
 113     docs
 114     ├── guides
 115     │   ├── onap-developer
 116     │   │   ├── apiref
 117     │   │   ├── architecture
 118     │   │   ├── developing
 119     │   │   ├── how-to-use-docs
 120     │   │   ├── settingup
 121     │   │   ├── tutorials
 122     │   │   └── use-cases
 123     │   ├── onap-provider
 124     │   └── onap-user
 125     ├── release
 126     └── templates
 127         ├── collections
 128         └── sections
 129
 130 Source Files
 131 ------------
 132 All documentation for project repositories should be structured and stored
 133 in or below `<your_project_repo>/docs/` directory as Restructured Text.
 134 ONAP jenkins jobs that verify and merge documentation are triggered by
 135 RST file changes in the top level docs directory and below.
 136
 137 Licensing
 138 ---------
 139 All contributions to the ONAP project are done in accordance with the
 140 ONAP licensing requirements.   Documentation in ONAP is contributed
 141 in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ license.
 142 All documentation files need to be licensed using the text below.
 143 The license may be applied in the first lines of all contributed RST
 144 files:
 145
 146 .. code-block:: bash
 147
 148  .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 149  .. http://creativecommons.org/licenses/by/4.0
 150  .. Copyright YEAR ONAP or COMPANY or INDIVIDUAL
 151
 152  These lines will not be rendered in the html and pdf files.
 153
 154 When there are subsequent, significant contributions to a source file
 155 from a different contributor, a new copyright line may be appended
 156 after the last existing copyright line.