#MacOs
.DS_Store
-.vscode/settings.json
+.vscode/
.. This work is licensed under a Creative Commons Attribution 4.0
.. International License. http://creativecommons.org/licenses/by/4.0
-Creating Documentation
-======================
+Contribution
+============
.. toctree::
:maxdepth: 2
- introduction
- setting-up
setting-up-environment
- style-guide
- api-swagger-guide
- converting-to-rst
-
-.. toctree::
- :hidden:
-
- update-review.rst
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2021 ONAP contributors, Nokia
-
-.. _templates:
-
-Templates
-=========
-
-This section provides templates for the projects
-
-.. toctree::
- :maxdepth: 2
-
- collections/sdk.rst
- collections/platform-component.rst
- sections/offeredapis.rst
- sections/consumedapis.rst
- sections/architecture.rst
- sections/design.rst
- sections/logging.rst
- sections/administration.rst
- sections/installation.rst
- sections/delivery.rst
- sections/userinterfaces.rst
- sections/release-notes.rst
- sections/build.rst
- sections/configuration.rst
.. toctree::
:maxdepth: 1
- how-to-use-docs/index
+ contribution/index
apiref/index
- how-to-use-docs/templates/index
-
-.. toctree::
- :maxdepth: 1
- :hidden:
.. _api-swagger-guide:
-API documentation
+API Documentation
=================
Swagger
- myAPI1.json
- myAPI2.json
-Global API table
+Global API Table
----------------
It is recommended to list the following API available with an access to the
Swagger JSON files to help the developers/users to play with JSON.
:header: "API name", "Swagger JSON"
:widths: 10,5
- "myAPI1", ":download:`link <myAPI1.json>`"
- "myAPI12", ":download:`link <myAPI2.json>`"
+ "myAPI1", ":download:`link <media/myAPI1.json>`"
+ "myAPI12", ":download:`link <media/myAPI2.json>`"
.. note::
During documentation merge/publish at RTD, any file referenced in an RST file with
.. note::
swaggerv2doc directive may generate errors when Swagger file contains specific
- information. In such case, do not use this direcive.
+ information. In such case, do not use this directive.
.. code:: rst
myAPI1
......
-.. swaggerv2doc:: myAPI1.json
+.. swaggerv2doc:: media/myAPI1.json
myAPI2
......
-.. swaggerv2doc:: myAPI2.json
+.. swaggerv2doc:: media/myAPI2.json
.. This work is licensed under a Creative Commons Attribution 4.0
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. Copyright 2022 ONAP
+.. _creating-rst:
-Setting Up
-==========
-
-ONAP documentation is stored in git repositories, changes are managed
-with gerrit reviews, and published documents generated when there is a
-change in any source used to build the documentation.
-
-Authors create source for documents in reStructured Text (RST) that is
-rendered to HTML and published on Readthedocs.io.
-The developer Wiki or other web sites can reference these rendered
-documents directly allowing projects to easily maintain current release
-documentation.
-
-Some initial set up is required to connect a project with
-the master document structure and enable automated publishing of
-changes as summarized in the following diagram and description below
-below.
-
-.. seqdiag::
- :height: 700
- :width: 1000
-
- seqdiag {
- DA [label = "Doc Project\nAuthor/Committer", color=lightblue];
- DR [label = "Doc Gerrit Repo" , color=pink];
- PR [label = "Other Project\nGerrit Repo", color=pink ];
- PA [label = "Other Project\nAuthor/Committer", color=lightblue];
-
- PA -> DR [label = "Add project repo as\ngit submodule" ];
- DR -> DA [label = "Review & Plan to\nIntegrate Content with\nTocTree Structure" ];
- DR <-- DA [label = "Vote +2/Merge" ];
- PA <-- DR [label = "Merge Notification" ];
- PA -> PR [label = "Create in project repo\ntop level directory and index.rst" ];
- PR -> DA [label = "Add as Reviewer" ];
- PR <-- DA [label = "Approve and Integrate" ];
- PA <-- PR [label = "Merge" ];
- }
-
-Setup project repositories
---------------------------
-These steps are performed for each project repository that
-provides documentation.
-
-1. Set two variables that will be used in the subsequent steps.
-Set *reponame* to the project repository you are setting up
-just as it appears in the **Project Name** column of
-the Gerrit projects page.
-Set *lfid* to your Linux Foundation identity that you use to
-login to gerrit or for git clone requests over ssh.
-
-.. code-block:: bash
-
- reponame=
- lfid=
-
-2. Add a directory in the doc project where your
-project will be included as a submodule and at least one reference
-from the doc project to the documentation index in your repository.
-The following sequence will do this over ssh. Please note that the
-reference to your project in *repolist.rst* should be considered
-temporary and removed when you reference it from more appropriate
-place.
-
-.. caution::
-
- If your access network restricts ssh, you will need to use equivalent
- git commands and HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_.
-
-.. caution::
-
- Don't replace ../ in *git submodule add* with any relative path on
- your local file system. It refers to the location of your repository
- on the server.
-
-.. code-block:: bash
-
- git clone ssh://$lfid@gerrit.onap.org:29418/doc
- cd doc
- mkdir -p `dirname docs/submodules/$reponame`
- git submodule add ../$reponame docs/submodules/$reponame.git
- git submodule init docs/submodules/$reponame.git
- git submodule update docs/submodules/$reponame.git
-
- echo " $reponame <../submodules/$reponame.git/docs/index>" >> docs/release/repolist.rst
-
- git add .
- git commit -s
- git review
-
-.. caution::
- Wait for the above change to be merged before any merge to the
- project repository that you have just added as a submodule.
- If the project repository added as submodule changes before the
- doc project merge, git may not automatically update the submodule
- reference on changes and/or the verify job will fail in the step below.
-
-
-3. Create a docs directory in your repository with
-an index.rst file. The following sequence will complete the minimum
-required over ssh. As you have time to convert or add new content you
-can update the index and add files under the docs folder.
-
-.. hint::
- If you have additional content, you can include it by editing the
- index.rst file and/or adding other files before the git commit.
- See `Templates and Examples`_ below and :ref:`converting-to-rst`
- for more information.
-
-
-.. code-block:: bash
-
- git clone ssh://$lfid@gerrit.onap.org:29418/$reponame
- cd $reponame
- mkdir docs
- echo ".. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
- TODO Add files to toctree and delete this header
- ------------------------------------------------
- .. toctree::
- :maxdepth: 1
-
- " > docs/index.rst
-
- git add .
- git commit -s
- git review
-
-
-The diagram below illustrates what is accomplished in the setup steps
-above from the perspective of a file structure created for a local test,
-a jenkins verify job, and/or published release documentation including:
-
-- ONAP gerrit project repositories,
-
-- doc project repository master document index.rst, templates,
- configuration, and other documents
-
-- submodules directory where other project repositories and
- directories/files are referenced
-
-- file structure: directories (ellipses), files(boxes)
-
-- references: directory/files (solid edges), git submodule
- (dotted edges), sphinx toctree (dashed edges)
-
-.. graphviz::
-
-
- digraph docstructure {
- size="8,12";
- node [fontname = "helvetica"];
- // Align gerrit repos and docs directories
- {rank=same doc aaf aai reponame repoelipse vnfsdk vvp}
- {rank=same confpy release templates masterindex submodules otherdocdocumentelipse}
- {rank=same releasedocumentindex releaserepolist}
-
- //Illustrate Gerrit Repos and provide URL/Link for complete repo list
- gerrit [label="gerrit.onap.org/r", href="https://gerrit.onap.org/r/#/admin/projects/" ];
- doc [href="https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree"];
- gerrit -> doc;
- gerrit -> aaf;
- gerrit -> aai;
- gerrit -> reponame;
- gerrit -> repoelipse;
- repoelipse [label=". . . ."];
- gerrit -> vnfsdk;
- gerrit -> vvp;
-
- //Show example of local reponame instance of component info
- reponame -> reponamedocsdir;
- reponamesm -> reponamedocsdir;
- reponamedocsdir [label="docs"];
- reponamedocsdir -> repnamedocsdirindex;
- repnamedocsdirindex [label="index.rst", shape=box];
-
- //Show detail structure of a portion of doc/docs
- doc -> docs;
- docs -> confpy;
- confpy [label="conf.py",shape=box];
- docs -> masterindex;
- masterindex [label="Master\nindex.rst", shape=box];
- docs -> release;
- docs -> templates;
- docs -> otherdocdocumentelipse;
- otherdocdocumentelipse [label="...other\ndocuments"];
- docs -> submodules
-
- masterindex -> releasedocumentindex [style=dashed, label="sphinx\ntoctree\nreference"];
-
- //Show submodule linkage to docs directory
- submodules -> reponamesm [style=dotted,label="git\nsubmodule\nreference"];
- reponamesm [label="reponame.git"];
-
- //Example Release document index that references component info provided in other project repo
- release -> releasedocumentindex;
- releasedocumentindex [label="index.rst", shape=box];
- releasedocumentindex -> releaserepolist [style=dashed, label="sphinx\ntoctree\nreference"];
- releaserepolist [label="repolist.rst", shape=box];
- release -> releaserepolist;
- releaserepolist -> repnamedocsdirindex [style=dashed, label="sphinx\ntoctree\nreference"];
-
- }
-
-Branches in the DOC Project
----------------------------
-
-The DOC project 'master' branch aggregates the 'latest' content
-from all ONAP project repositories contributing documentation into a
-single tree file structure as described in the previous section. This
-branch is continuously integrated and deployed at Read The
-Docs as the 'latest' ONAP Documentation by:
-
-* Jenkins doc-verify-rtd and doc-merge-rtd jobs triggered whenever patches on
- contributing repositories contain rst files at or below a top level
- 'docs' folder.
-
-* Subscription in the DOC project to changes in submodule repositories.
- These changes appear in the DOC project as commits with title
- 'Updated git submodules' when a change to a contributing project
- repository is merged. No DOC project code review occurs, only a
- submodule repository commit hash is updated to track the head of each
- contributing master branch.
-
-For each ONAP named release the DOC project creates a branch with the
-release name. The timing of the release branch is determined by
-work needed in the DOC project to prepare the release branch and the
-amount of change unrelated to the release in the master branch.
-For example contributing projects that create named release branches
-early to begin work on the next release and/or contributing projects
-to the master that are not yet part of the named release would result
-in an earlier named release branch to cleanly separate work to stabilize
-a release from other changes in the master branch.
-
-A named release branch is integrated and deployed at Read The Docs
-as the 'named release' by aggregating content from contributing
-project repositories. A contributing project repository can
-choose one of the following for the 'named release' branch:
-
-* Remove the contributing project repository submodule and RST
- references when not part of the named release.
-
-* Provide a commit hash or tag for the contributing project master
- branch to be used for the life of the release branch or until a
- request is submitted to change the commit hash or tag.
-
-* Provide the commit hash for the head of a named release branch
- created in the contributing project repository. This option
- may be appropriate if frequent changes are expected over the
- life of the named release and work the same way as the continuous
- integration and deployment described for the master branch.
-
-The decision on option for each contributing project repository
-can be made or changed before the final release is approved. The
-amount of change and expected differences between master and a
-named release branch for each repository should drive the choice of
-option and timing.
-
-About GIT branches
-------------------
-
-GIT is a powerful tool allowing many actions, but without respecting some rules
-the GIT structure can be quickly hard to maintain.
-
-Here are some conventions about GIT branches:
-
- - ALWAYS create a local branch to edit or create any file. This local branch
- will be considered as a topic in Gerrit and allow contributors to
- work at the same time on the same project.
-
- - 1 feature = 1 branch. In the case of documentation, a new chapter
- or page about a new code feature can be considered as a 'doc feature'
-
- - 1 bug = 1 branch. In the case of documentation, a correction on an
- existing sentence can be considered as a 'doc bug'
-
- - the master branch is considered as "unstable", containing new features that
- will converge to a stable situation for the release date.
-
-The day of the release, the repository owner will create a new branch to
-fix the code and documentation. This will represent the 'stable' code of the
-release. In this context:
-
- - NEVER push a new feature on a stable branch
-
- - Only bug correction are authorized on a stable branch using
- cherry pick method
-
-.. image:: git_branches.png
-
-Creating Restructured Text
-==========================
+Creating ReStructuredText
+=========================
ReStructuredText markup conventions
-----------------------------------
more < docs/_build/linkcheck/output.txt
tox -espellcheck
- more < docs/_build/spellcheck/output.txt
+ more < docs/_build/spellcheck/output.txt
\ No newline at end of file
contribute to the ONAP documentation project.
Currently some content resides also in the Developer Guide. This is subject to
-be reviewed, updated and migrated to the ONAP Documenation Guide.
+be reviewed, updated and migrated to the ONAP Documentation Guide.
.. toctree::
:maxdepth: 1
- setup-of-a-doc-dev-system.rst
+ introduction
+ setting-up
+ setup-of-a-doc-dev-system
+ style-guide-content
+ creating-rst
+ converting-to-rst
+ updates-and-review
+ api-swagger-guide
+ templates/index
.. This work is licensed under a Creative Commons Attribution 4.0
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. Copyright 2022 ONAP
Introduction
============
This guide describes how to create documentation for the Open Network
-Automation Platform (ONAP). ONAP projects create a variety of
-content depending on the nature of the project. For example projects
+Automation Platform (ONAP). ONAP projects create a variety of
+content depending on the nature of the project. For example projects
delivering a platform component may have different types of content than
a project that creates libraries for a software development kit.
The content from each project may be used together as a reference for
How do I create ONAP documentation?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ONAP documentation is written in ReStructuredText_ (an easy-to-read,
-what-you-see-is-what-you-get, plain text markup syntax). The process for
+what-you-see-is-what-you-get, plain text markup syntax). The process for
creating ONAP documentation and what documents are required are
described in later sections of this Developer Documentation Guide.
In the past, standard documentation methods included ad-hoc Word documents,
PDFs, poorly organized Wikis, and other, often closed, tools like
-Adobe FrameMaker. The rise of DevOps, Agile, and Continuous Integration,
+Adobe FrameMaker. The rise of DevOps, Agile, and Continuous Integration,
however, created a paradigm shift for those who care about documentation
because:
have built-in functionality that makes collating and cross-referencing
component documentation easier.
-Which docs should go where?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Which documents should go where?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A TSC Vote (2020, Feb. 19) approved the following usage policy:
-Frequently, developers ask where documentation should be created. Should
-they always use reStructuredText/Sphinx? Not necessarily. Is the wiki
-appropriate for anything at all? Yes.
+**DEVELOPER WIKI** is used for ONAP release, project, subcommitee and
+development related content, e.g.
-It's really up to the development team. Here is a simple rule:
+- project management (meetings, plans, milestones, members, ...)
+- project specific development guides
+- ongoing activities and discussions
+- ONAP community event documentation
+
+**READ THE DOCS** is used for all formal ONAP E2E and component documentation,
+e.g.
+
+- ONAP overview, architecture, API
+- ONAP developer guides (e.g. Documentation guide)
+- ONAP user guides (E2E)
+- ONAP component guides, release notes
+- ONAP administration/operations guides
+- ONAP use-case description and usage
+- ONAP tutorials
+- ONAP release notes
The more tightly coupled the documentation is to a particular version
of the code, the more likely it is that it should be stored with the
4. Wiki articles tend to grow in size and not maintained making it hard
to find current information.
-Structure
----------
-A top level master document structure is used to organize all
-documents created by ONAP projects and this resides in the gerrit doc
-repository. Complete documents or guides may reside here and
-reference parts of source for documentation from other project
-repositories. Other ONAP projects will provide content that
-is referenced from this structure.
-
-.. code-block::
-
- docs
- ├── guides
- │  ├── onap-developer
- │  │  ├── apiref
- │  │  ├── architecture
- │  │  │  └── media
- │  │  ├── developing
- │  │  └── how-to-use-docs
- | | | ├── templates
- │  | | | ├── collections
- │  | | | └── sections
- │  ├── onap-operator
- │  │  ├── cloud_site
- │  │  │  ├── aws
- │  │  │  ├── azure
- │  │  │  ├── k8s
- │  │  │  ├── openstack
- │  │  │  └── vmware
- │  │  ├── onap-portal-admin
- │  │  │  └── attachments
- │  │  └── settingup
- │  ├── onap-provider
- │  ├── onap-user
- │  │  ├── configure
- │  │  │  ├── change_config
- │  │  │  ├── pnf_connect
- │  │  │  └── vnf_connect
- │  │  ├── design
- │  │  │  ├── control-loop
- │  │  │  │  └── media
- │  │  │  ├── media
- │  │  │  ├── parameter_resolution
- │  │  │  │  └── ubuntu_example
- │  │  │  │  ├── cba-after-enrichment
- │  │  │  │  │  ├── Definitions
- │  │  │  │  │  ├── Templates
- │  │  │  │  │  └── TOSCA-Metadata
- │  │  │  │  ├── cba-before-enrichment
- │  │  │  │  │  ├── Definitions
- │  │  │  │  │  ├── Templates
- │  │  │  │  │  └── TOSCA-Metadata
- │  │  │  │  └── ubuntuCDS_heat
- │  │  │  ├── pre-onboarding
- │  │  │  │  └── media
- │  │  │  ├── resource-onboarding
- │  │  │  │  └── media
- │  │  │  ├── service-design
- │  │  │  │  └── media
- │  │  │  ├── service-distribution
- │  │  │  │  └── media
- │  │  │  └── vfcreation
- │  │  │  └── media
- │  │  ├── instantiate
- │  │  │  ├── instantiation
- │  │  │  │  ├── nbi
- │  │  │  │  ├── pnf_instance
- │  │  │  │  ├── service_instance
- │  │  │  │  ├── so1
- │  │  │  │  ├── so2
- │  │  │  │  ├── uui
- │  │  │  │  ├── vid
- │  │  │  │  ├── virtual_link_instance
- │  │  │  │  └── vnf_instance
- │  │  │  └── pre_instantiation
- │  │  └── onap-portal-user
- │  │  └── attachments
- │  └── overview
- │  └── media
- └── release
-
-
Source Files
------------
All documentation for project repositories should be structured and stored
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. Copyright 2022 ONAP
+
+.. _setting-up:
+
+Setting Up
+==========
+
+.. warning:: This guide describes the concept of using 'submodules' for
+ documentation. Submodules are no longer supported and have been removed.
+ This guide is partly outdated and needs an update.
+
+ The aggregation of individual project documentation to a coherent set of
+ ONAP release documentation is now done in ReadTheDocs using the ONAP 'doc'
+ project as its root.
+
+ONAP documentation is stored in git repositories, changes are managed
+with gerrit reviews, and published documents generated when there is a
+change in any source used to build the documentation.
+
+Authors create source for documents in reStructured Text (RST) that is
+rendered to HTML and published on Readthedocs.io.
+The developer Wiki or other web sites can reference these rendered
+documents directly allowing projects to easily maintain current release
+documentation.
+
+Some initial set up is required to connect a project with
+the master document structure and enable automated publishing of
+changes as summarized in the following diagram and description below
+below.
+
+.. seqdiag::
+ :height: 700
+ :width: 1000
+
+ seqdiag {
+ DA [label = "Doc Project\nAuthor/Committer", color=lightblue];
+ DR [label = "Doc Gerrit Repo" , color=pink];
+ PR [label = "Other Project\nGerrit Repo", color=pink ];
+ PA [label = "Other Project\nAuthor/Committer", color=lightblue];
+
+ PA -> DR [label = "Add project repo as\ngit submodule" ];
+ DR -> DA [label = "Review & Plan to\nIntegrate Content with\nTocTree Structure" ];
+ DR <-- DA [label = "Vote +2/Merge" ];
+ PA <-- DR [label = "Merge Notification" ];
+ PA -> PR [label = "Create in project repo\ntop level directory and index.rst" ];
+ PR -> DA [label = "Add as Reviewer" ];
+ PR <-- DA [label = "Approve and Integrate" ];
+ PA <-- PR [label = "Merge" ];
+ }
+
+Setup project repositories
+--------------------------
+These steps are performed for each project repository that
+provides documentation.
+
+1. Set two variables that will be used in the subsequent steps.
+Set *reponame* to the project repository you are setting up
+just as it appears in the **Project Name** column of
+the Gerrit projects page.
+Set *lfid* to your Linux Foundation identity that you use to
+login to gerrit or for git clone requests over ssh.
+
+.. code-block:: bash
+
+ reponame=
+ lfid=
+
+2. Add a directory in the doc project where your
+project will be included as a submodule and at least one reference
+from the doc project to the documentation index in your repository.
+The following sequence will do this over ssh. Please note that the
+reference to your project in *repolist.rst* should be considered
+temporary and removed when you reference it from more appropriate
+place.
+
+.. caution::
+
+ If your access network restricts ssh, you will need to use equivalent
+ git commands and HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_.
+
+.. caution::
+
+ Don't replace ../ in *git submodule add* with any relative path on
+ your local file system. It refers to the location of your repository
+ on the server.
+
+.. code-block:: bash
+
+ git clone ssh://$lfid@gerrit.onap.org:29418/doc
+ cd doc
+ mkdir -p `dirname docs/submodules/$reponame`
+ git submodule add ../$reponame docs/submodules/$reponame.git
+ git submodule init docs/submodules/$reponame.git
+ git submodule update docs/submodules/$reponame.git
+
+ echo " $reponame <../submodules/$reponame.git/docs/index>" >> docs/release/repolist.rst
+
+ git add .
+ git commit -s
+ git review
+
+.. caution::
+ Wait for the above change to be merged before any merge to the
+ project repository that you have just added as a submodule.
+ If the project repository added as submodule changes before the
+ doc project merge, git may not automatically update the submodule
+ reference on changes and/or the verify job will fail in the step below.
+
+
+3. Create a docs directory in your repository with
+an index.rst file. The following sequence will complete the minimum
+required over ssh. As you have time to convert or add new content you
+can update the index and add files under the docs folder.
+
+.. hint::
+ If you have additional content, you can include it by editing the
+ index.rst file and/or adding other files before the git commit.
+ Check "Templates and Examples" section in :ref:`setting-up` and
+ :ref:`converting-to-rst` for more information.
+
+
+.. code-block:: bash
+
+ git clone ssh://$lfid@gerrit.onap.org:29418/$reponame
+ cd $reponame
+ mkdir docs
+ echo ".. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+ TODO Add files to toctree and delete this header
+ ------------------------------------------------
+ .. toctree::
+ :maxdepth: 1
+
+ " > docs/index.rst
+
+ git add .
+ git commit -s
+ git review
+
+
+The diagram below illustrates what is accomplished in the setup steps
+above from the perspective of a file structure created for a local test,
+a jenkins verify job, and/or published release documentation including:
+
+- ONAP gerrit project repositories,
+
+- doc project repository master document index.rst, templates,
+ configuration, and other documents
+
+- submodules directory where other project repositories and
+ directories/files are referenced
+
+- file structure: directories (ellipses), files(boxes)
+
+- references: directory/files (solid edges), git submodule
+ (dotted edges), sphinx toctree (dashed edges)
+
+.. graphviz::
+
+
+ digraph docstructure {
+ size="8,12";
+ node [fontname = "helvetica"];
+ // Align gerrit repos and docs directories
+ {rank=same doc aaf aai reponame repoelipse vnfsdk vvp}
+ {rank=same confpy release templates masterindex submodules otherdocdocumentelipse}
+ {rank=same releasedocumentindex releaserepolist}
+
+ //Illustrate Gerrit Repos and provide URL/Link for complete repo list
+ gerrit [label="gerrit.onap.org/r", href="https://gerrit.onap.org/r/#/admin/projects/" ];
+ doc [href="https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree"];
+ gerrit -> doc;
+ gerrit -> aaf;
+ gerrit -> aai;
+ gerrit -> reponame;
+ gerrit -> repoelipse;
+ repoelipse [label=". . . ."];
+ gerrit -> vnfsdk;
+ gerrit -> vvp;
+
+ //Show example of local reponame instance of component info
+ reponame -> reponamedocsdir;
+ reponamesm -> reponamedocsdir;
+ reponamedocsdir [label="docs"];
+ reponamedocsdir -> repnamedocsdirindex;
+ repnamedocsdirindex [label="index.rst", shape=box];
+
+ //Show detail structure of a portion of doc/docs
+ doc -> docs;
+ docs -> confpy;
+ confpy [label="conf.py",shape=box];
+ docs -> masterindex;
+ masterindex [label="Master\nindex.rst", shape=box];
+ docs -> release;
+ docs -> templates;
+ docs -> otherdocdocumentelipse;
+ otherdocdocumentelipse [label="...other\ndocuments"];
+ docs -> submodules
+
+ masterindex -> releasedocumentindex [style=dashed, label="sphinx\ntoctree\nreference"];
+
+ //Show submodule linkage to docs directory
+ submodules -> reponamesm [style=dotted,label="git\nsubmodule\nreference"];
+ reponamesm [label="reponame.git"];
+
+ //Example Release document index that references component info provided in other project repo
+ release -> releasedocumentindex;
+ releasedocumentindex [label="index.rst", shape=box];
+ releasedocumentindex -> releaserepolist [style=dashed, label="sphinx\ntoctree\nreference"];
+ releaserepolist [label="repolist.rst", shape=box];
+ release -> releaserepolist;
+ releaserepolist -> repnamedocsdirindex [style=dashed, label="sphinx\ntoctree\nreference"];
+
+ }
+
+Branches in the DOC Project
+---------------------------
+
+The DOC project 'master' branch aggregates the 'latest' content
+from all ONAP project repositories contributing documentation into a
+single tree file structure as described in the previous section. This
+branch is continuously integrated and deployed at Read The
+Docs as the 'latest' ONAP Documentation by:
+
+* Jenkins doc-verify-rtd and doc-merge-rtd jobs triggered whenever patches on
+ contributing repositories contain rst files at or below a top level
+ 'docs' folder.
+
+* Subscription in the DOC project to changes in submodule repositories.
+ These changes appear in the DOC project as commits with title
+ 'Updated git submodules' when a change to a contributing project
+ repository is merged. No DOC project code review occurs, only a
+ submodule repository commit hash is updated to track the head of each
+ contributing master branch.
+
+For each ONAP named release the DOC project creates a branch with the
+release name. The timing of the release branch is determined by
+work needed in the DOC project to prepare the release branch and the
+amount of change unrelated to the release in the master branch.
+For example contributing projects that create named release branches
+early to begin work on the next release and/or contributing projects
+to the master that are not yet part of the named release would result
+in an earlier named release branch to cleanly separate work to stabilize
+a release from other changes in the master branch.
+
+A named release branch is integrated and deployed at Read The Docs
+as the 'named release' by aggregating content from contributing
+project repositories. A contributing project repository can
+choose one of the following for the 'named release' branch:
+
+* Remove the contributing project repository submodule and RST
+ references when not part of the named release.
+
+* Provide a commit hash or tag for the contributing project master
+ branch to be used for the life of the release branch or until a
+ request is submitted to change the commit hash or tag.
+
+* Provide the commit hash for the head of a named release branch
+ created in the contributing project repository. This option
+ may be appropriate if frequent changes are expected over the
+ life of the named release and work the same way as the continuous
+ integration and deployment described for the master branch.
+
+The decision on option for each contributing project repository
+can be made or changed before the final release is approved. The
+amount of change and expected differences between master and a
+named release branch for each repository should drive the choice of
+option and timing.
+
+About GIT branches
+------------------
+
+GIT is a powerful tool allowing many actions, but without respecting some rules
+the GIT structure can be quickly hard to maintain.
+
+Here are some conventions about GIT branches:
+
+ - ALWAYS create a local branch to edit or create any file. This local branch
+ will be considered as a topic in Gerrit and allow contributors to
+ work at the same time on the same project.
+
+ - 1 feature = 1 branch. In the case of documentation, a new chapter
+ or page about a new code feature can be considered as a 'doc feature'
+
+ - 1 bug = 1 branch. In the case of documentation, a correction on an
+ existing sentence can be considered as a 'doc bug'
+
+ - the master branch is considered as "unstable", containing new features that
+ will converge to a stable situation for the release date.
+
+The day of the release, the repository owner will create a new branch to
+fix the code and documentation. This will represent the 'stable' code of the
+release. In this context:
+
+ - NEVER push a new feature on a stable branch
+
+ - Only bug correction are authorized on a stable branch using
+ cherry pick method
+
+.. image:: media/git_branches.png
11.x.x (Kohn) - 10.x.x (Jakarta)
Last Review/Update
- 28/07/2022
+ 02/08/2022
Initial Release
05/12/2021
- `Write The Docs: Documentation Guide <https://www.writethedocs.org/guide>`__
- `Techwriter Documatt Blog <https://techwriter.documatt.com/>`__
+Gerrit
+------
+
+- `LF RelEng Gerrit Guide <https://docs.releng.linuxfoundation.org/en/latest/gerrit.html>`_
+
Git
---
+- `LF RelEng Git Guide <https://docs.releng.linuxfoundation.org/en/latest/git.html>`__
- `How To Install Git on Ubuntu 20.04 <https://www.digitalocean.com/community/tutorials/how-to-install-git-on-ubuntu-20-04>`__
Python
.. This work is licensed under a Creative Commons Attribution 4.0
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. Copyright 2022 ONAP
-Style guide
-===========
+Style Guide (Content)
+=====================
This style guide is for ONAP documentation contributors, reviewers and
-committers.
+committers and covers content related topics.
Writing guidelines
------------------
+ Examples: an MSO component, a LAN, an L3-VPN
-
ONAP terminology
^^^^^^^^^^^^^^^^
- AA&I vs AAI: AAI should be used.
- run time (noun). Example: "logging of events at run time".
-GUI elements
+GUI Elements
^^^^^^^^^^^^
- In general, write menu names as they appear in the UI.
For example, if a menu or item name is all caps, then write
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2021 ONAP Contributors, Nokia
+
+.. _templates:
+
+Templates
+=========
+
+This section provides documentation templates for the ONAP projects. We have
+gathered a typical set of documents for a SDK and a Platform Component. But
+feel free to add or remove templates based on your requirements.
+
+.. toctree::
+ :maxdepth: 2
+
+ collections/sdk.rst
+ collections/platform-component.rst
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
-
.. _master_index:
Open Network Automation Platform
| | functionalities of ONAP. Basic guidelines on license details, limitations and |
| | security references support understanding the solution. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`ONAP Architecture <ONAP-architecture>` | The ONAP Architecture and its functional elements are described in details |
- | | here. We can learn how the two main frameworks, namely the Design-time |
- | | framework and the Run-time framework cooperate and how the Microservices, |
- | | Common services and the ONAP Portal support the certain functions. |
+ | :ref:`ONAP Architecture <ONAP-architecture>` | The ONAP Architecture and its functional elements are described in details here. You can learn|
+ | | how the two main frameworks, namely the Design-time framework and the Run-time framework |
+ | | cooperate and how the Microservices and Common services support certain functions. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`ONAP Components and Functionalities <doc_onap-developer_guide_projects>` | The ONAP Components and Functionalities are described in details here. |
- | | We can learn what functionalities ONAP provides and how the certain components in |
- | | ONAP operate together. |
+ | :ref:`ONAP Components and Functionalities <doc_onap-developer_guide_projects>` | The ONAP Components and Functionalities are described in details here. You can learn what |
+ | | functionalities ONAP provides and how the certain components in ONAP operate together. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform operation and adminstration cover the configuration and installation of ONAP, |
- | | its management, monitoring and other operational tasks (integration, user management,...) |
+ | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform Operations and Adminstration covers the configuration and installation of ONAP, |
+ | | its management, monitoring and other operational tasks (integration, user management, ...) |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`User Guides <user-guides>` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, |
| | instantiation and their management using control loops |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Developer Guides <ONAP_developer_guides>` | Developers contributing to the ONAP development can find crucial information |
- | | in the Developer Guides. The reader can search among the developers’ topics |
- | | in alphabetical order. |
+ | :ref:`Developer Guides <ONAP_developer_guides>` | Developers contributing to the ONAP development can find crucial information in the Developer |
+ | | Guides. You can search among the developers’ topics in alphabetical order. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Documentation Guides <ONAP_documentation_guides>` | People interested in the creation of ONAP documentation can find crucial information |
- | | in the ONAP Documentation Guide. Currently some content resides also in the Developer Guide. |
- | | This is subject to be reviewed, updated and migrated to the ONAP Documenation Guide. |
+ | :ref:`Documentation Guides <ONAP_documentation_guides>` | People interested in the creation of ONAP documentation can find crucial information in the |
+ | | ONAP Documentation Guide. Currently some content resides also in the Developer Guide. This is |
+ | | subject to be reviewed, updated and migrated to the ONAP Documentation Guide. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. We can learn about discovered and fixed |
| | vulnerabilities. |
Code Review / doc.git / commitdiff
