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.
9 Some initial set up is required to connect a project with
10 the master document structure and enable automated publishing of
11 changes as summarized in the following diagram and description below
19 DA [label = "Doc Project\nAuthor/Committer", color=lightblue];
20 DR [label = "Doc Gerrit Repo" , color=pink];
21 PR [label = "Other Project\nGerrit Repo", color=pink ];
22 PA [label = "Other Project\nAuthor/Committer", color=lightblue];
24 PA -> DR [label = "Add project repo as\ngit submodule" ];
25 DR -> DA [label = "Review & Plan to\nIntegrate Content with\nTocTree Structure" ];
26 DR <-- DA [label = "Vote +2/Merge" ];
27 PA <-- DR [label = "Merge Notification" ];
28 PA -> PR [label = "Create in project repo\ntop level directory and index.rst" ];
29 PR -> DA [label = "Add as Reviewer" ];
30 PR <-- DA [label = "Approve and Integrate" ];
31 PA <-- PR [label = "Merge" ];
34 Setup project repositories(s)
35 -----------------------------
36 These steps are performed for each project repository that
37 provides documentation.
39 First let's set two variables that will be used in the subsequent steps.
40 Set *reponame* to the project repository you are setting up
41 just as it appears in the **Project Name** column of
42 the Gerrit projects page.
43 Set *lfid* to your Linux Foundation identity that you use to
44 login to gerrit or for git clone requests over ssh.
51 The next step is to add a directory in the doc project where your
52 project will be included as a submodule and at least one reference
53 from the doc project to the documentation index in your repository.
54 The following sequence will do this over ssh.
58 If your access network restricts ssh, you will need to use equivalent
59 git commands and HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_.
63 git clone ssh://$lfid@gerrit.onap.org:29418/doc
65 mkdir -p `dirname docs/submodules/$reponame`
66 git submodule add ../$reponame docs/submodules/$reponame.git
67 git submodule init docs/submodules/$reponame.git
68 git submodule update docs/submodules/$reponame.git
70 echo " $reponame <../submodules/$reponame.git/docs/index>" >> docs/release/repolist.rst
77 Wait for the above change to be merged before any merge to the
78 project repository that you have just added as a submodule.
79 If the project repository added as submodule changes before the
80 doc project merge, git may not automatically update the submodule
81 reference on changes and/or the verify job will fail in the step below.
84 The last step is to create a docs directory in your repository with
85 an index.rst file. The following sequence will complete the minimum
86 required over ssh. As you have time to convert or add new content you
87 can update the index and add files under the docs folder.
90 If you have additional content, you can include it by editing the
91 index.rst file and/or adding other files before the git commit.
92 See `Templates and Examples`_ below and :ref:`converting-to-rst`
98 git clone ssh://$lfid@gerrit.onap.org:29418/$reponame
101 echo ".. This work is licensed under a Creative Commons Attribution 4.0 International License.
103 TODO Add files to toctree and delete this header
104 ------------------------------------------------
115 The diagram below illustrates what is accomplished in the setup steps
116 above from the perspective of a file structure created for a local test,
117 a jenkins verify job, and/or published release documentation including:
119 - ONAP gerrit project repositories,
121 - doc project repository master document index.rst, templates,
122 configuration, and other documents
124 - submodules directory where other project repositories and
125 directories/files are referenced
127 - file structure: directories (ellipses), files(boxes)
129 - references: directory/files (solid edges), git submodule
130 (dotted edges), sphinx toctree (dashed edges)
135 digraph docstructure {
137 node [fontname = "helvetica"];
138 // Align gerrit repos and docs directories
139 {rank=same doc aaf aai reponame repoelipse vnfsdk vvp}
140 {rank=same confpy release templates masterindex submodules otherdocdocumentelipse}
141 {rank=same releasedocumentindex releaserepolist}
143 //Illustrate Gerrit Repos and provide URL/Link for complete repo list
144 gerrit [label="gerrit.onap.org/r", href="https://gerrit.onap.org/r/#/admin/projects/" ];
145 doc [href="https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree"];
150 gerrit -> repoelipse;
151 repoelipse [label=". . . ."];
155 //Show example of local reponame instance of component info
156 reponame -> reponamedocsdir;
157 reponamesm -> reponamedocsdir;
158 reponamedocsdir [label="docs"];
159 reponamedocsdir -> repnamedocsdirindex;
160 repnamedocsdirindex [label="index.rst", shape=box];
162 //Show detail structure of a portion of doc/docs
165 confpy [label="conf.py",shape=box];
167 masterindex [label="Master\nindex.rst", shape=box];
170 docs -> otherdocdocumentelipse;
171 otherdocdocumentelipse [label="...other\ndocuments"];
174 masterindex -> releasedocumentindex [style=dashed, label="sphinx\ntoctree\nreference"];
176 //Show submodule linkage to docs directory
177 submodules -> reponamesm [style=dotted,label="git\nsubmodule\nreference"];
178 reponamesm [label="reponame.git"];
180 //Example Release document index that references component info provided in other project repo
181 release -> releasedocumentindex;
182 releasedocumentindex [label="index.rst", shape=box];
183 releasedocumentindex -> releaserepolist [style=dashed, label="sphinx\ntoctree\nreference"];
184 releaserepolist [label="repolist.rst", shape=box];
185 release -> releaserepolist;
186 releaserepolist -> repnamedocsdirindex [style=dashed, label="sphinx\ntoctree\nreference"];
190 Branches in the DOC Project
191 ---------------------------
193 The DOC project 'master' branch aggregates the 'latest' content
194 from all ONAP project repositories contributing documentation into a
195 single tree file structure as described in the previous section. This
196 branch is continuously integrated and deployed at Read The
197 Docs as the 'latest' ONAP Documentation by:
199 * Jenkins doc-verify-rtd and doc-merge-rtd jobs triggered whenever patches on
200 contributing repositories contain rst files at or below a top level
203 * Subscription in the DOC project to changes in submodule repositories.
204 These changes appear in the DOC project as commits with title
205 'Updated git submodules' when a change to a contributing project
206 repository is merged. No DOC project code review occurs, only a
207 submodule repository commit hash is updated to track the head of each
208 contributing master branch.
210 For each ONAP named release the DOC project creates a branch with the
211 release name. The timing of the release branch is determined by
212 work needed in the DOC project to prepare the release branch and the
213 amount of change unrelated to the release in the master branch.
214 For example contributing projects that create named release branches
215 early to begin work on the next release and/or contributing projects
216 to the master that are not yet part of the named release would result
217 in an earlier named release branch to cleanly separate work to stabilize
218 a release from other changes in the master branch.
220 A named release branch is integrated and deployed at Read The Docs
221 as the 'named release' by aggregating content from contributing
222 project repositories. A contributing project repository can
223 choose one of the following for the 'named release' branch:
225 * Remove the contributing project repository submodule and RST
226 references when not part of the named release.
228 * Provide a commit hash or tag for the contributing project master
229 branch to be used for the life of the release branch or until a
230 request is submitted to change the commit hash or tag.
232 * Provide the commit hash for the head of a named release branch
233 created in the contributing project repository. This option
234 may be appropriate if frequent changes are expected over the
235 life of the named release and work the same way as the continuous
236 integration and deployment described for the master branch.
238 The decision on option for each contributing project repository
239 can be made or changed before the final release is approved. The
240 amount of change and expected differences between master and a
241 named release branch for each repository should drive the choice of
247 GIT is a powerful tool allowing many actions, but without respecting some rules
248 the GIT structure can be quickly hard to maintain.
250 Here are some conventions about GIT branches:
252 - ALWAYS create a local branch to edit or create any file. This local branch
253 will be considered as a topic in Gerrit and allow contributors to
254 work at the same time on the same project.
256 - 1 feature = 1 branch. In the case of documentation, a new chapter
257 or page about a new code feature can be considered as a 'doc feature'
259 - 1 bug = 1 branch. In the case of documentation, a correction on an
260 existing sentence can be considered as a 'doc bug'
262 - the master branch is considered as "unstable", containing new features that
263 will converge to a stable situation for the release date.
265 The day of the release, the repository owner will create a new branch to
266 fix the code and documentation. This will represent the 'stable' code of the
267 release. In this context:
269 - NEVER push a new feature on a stable branch
271 - Only bug correction are authorized on a stable branch using
274 .. image:: git_branches.png
276 Creating Restructured Text
277 ==========================
279 Templates and Examples
280 ----------------------
281 Templates are available that capture the kinds of information
282 useful for different types of projects and provide some examples of
283 restructured text. We organize templates in the following way to:
285 - help authors understand relationships between documents
287 - keep the user audience context in mind when writing and
289 - tailor sections for different kinds of projects.
292 **Sections** Represent a certain type of content. A section
293 is **provided** in an project repository, to describe something about
294 the characteristics, use, capability, etc. of things in that repository.
295 A section may also be **referenced** from other sections and in
296 other repositories. For example, an API specification provided in a project
297 repository might be referenced to in a Platform API Reference Guide.
298 The notes in the beginning of each section template provide
299 additional detail about what is typically covered and where
300 there may be references to the section.
302 **Collections** Are a set of sections that are typically provided
303 for a particular type of project, repository, guide, reference manual, etc.
304 For example, a collection for a platform component, an SDK, etc.
306 You can: browse the template *collections* and *sections* below;
307 show source to look at the Restructured Text and Sphinx directives used;
308 copy the source either from a browser window or by downloading the
309 file in raw form from
310 the `gerrit doc repository <https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree;f=docs/templates;/>`_ and
311 then add them to your repository docs folder and index.rst.
321 ../../../templates/sections/*
331 ../../../templates/collections/*
335 In addition to these simple templates and examples
336 there are many open source projects (e.g. Open Daylight, Open Stack)
337 that are using Sphinx and Readthedocs where you may find examples
338 to start with. Working with project teams we will continue to enhance
339 templates here and capture frequently asked questions on the developer
340 wiki question topic `documentation <https://wiki.onap.org/questions/topics/16384055/documentation>`_.
344 - decide what is relevant content
346 - determine the best way to create/maintain it in the CI/CD process and
348 - work with the documentation team to reference content from the
349 master index and guides.
351 Consider options including filling in a template, identifying existing
352 content that can be used as is or easily converted, and use of Sphinx
353 directives/extensions to automatically generate restructured text
354 from other source you already have.
358 It's pretty common to want to reference another location in the
359 ONAP documentation and it's pretty easy to do with
360 reStructuredText. This is a quick primer, more information is in the
361 `Sphinx section on Cross-referencing arbitrary locations
362 <http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_.
364 Within a single document, you can reference another section simply by::
366 This is a reference to `The title of a section`_
368 Assuming that somewhere else in the same file there a is a section
369 title something like::
371 The title of a section
372 ^^^^^^^^^^^^^^^^^^^^^^
374 It's typically better to use ``:ref:`` syntax and labels to provide
375 links as they work across files and are resilient to sections being
376 renamed. First, you need to create a label something like::
380 The title of a section
381 ^^^^^^^^^^^^^^^^^^^^^^
383 .. note:: The underscore (_) before the label is required.
385 Then you can reference the section anywhere by simply doing::
387 This is a reference to :ref:`a-label`
391 This is a reference to :ref:`a section I really liked <a-label>`
393 .. note:: When using ``:ref:``-style links, you don't need a trailing
396 Because the labels have to be unique, it usually makes sense to prefix
397 the labels with the project name to help share the label space, e.g.,
398 ``sfc-user-guide`` instead of just ``user-guide``.
405 It is recommended that all rst content is validated by `doc8 <https://pypi.python.org/pypi/doc8>`_ standards.
406 To validate your rst files using doc8, install doc8.
410 sudo pip install doc8
412 doc8 can now be used to check the rst files. Execute as,
416 doc8 --ignore D000,D001 <file>
422 To test how the documentation renders in HTML, follow these steps:
424 Install virtual environment.
428 sudo pip install virtualenv
429 cd /local/repo/path/to/project
431 Download the doc repository.
435 git clone http://gerrit.onap.org/r/doc
437 Change directory to doc & install requirements.
442 sudo pip install -r etc/requirements.txt
444 Move the conf.py file to your project folder where RST files have been kept:
448 mv doc/docs/conf.py <path-to-your-folder>/
450 Move the static files to your project folder:
454 mv docs/_static/ <path-to-your-folder>/
456 Build the documentation from within your project folder:
460 sphinx-build -b html <path-to-your-folder> <path-to-output-folder>
462 Your documentation shall be built as HTML inside the
463 specified output folder directory.
465 .. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`. This is for testing only. Only commit the rst files and related content.
467 .. _building-all-documentation:
471 To build the all documentation under doc/, follow these steps:
473 Install virtual environment.
477 sudo pip install virtualenv
478 cd /local/repo/path/to/project
480 Download the DOC repository.
484 git clone http://gerrit.onap.org/r/doc
486 Build documentation using tox local environment & then open using any browser.
492 firefox docs/_build/html/index.html
494 .. note:: Make sure to run `tox -elocal` and not just `tox`.
496 There are additional tox environment options for checking External
497 URLs and Spelling. Use the tox environment options below and then
498 look at the output with the Linux `more` or similar command for
499 scanning for output that applies to the files you are validating.
504 more < docs/_build/linkcheck/output.txt
507 more < docs/_build/spellcheck/output.txt