1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. _updates-and-review:
8 Most project owners will need only to concern themselves with their own
9 project documentation. However, documentation team members and certain
10 project owners will need to edit and test multiple documentation repositories.
15 #. Create a JIRA task in the `ONAP JIRA <https://jira.onap.org/>`_
16 before you start the updates. The created issue's ID will have to be added to
20 The task should be created in the affected project's workspace. The release
21 should be specified, as well.
23 #. If you have not cloned the repository yet, follow the instructions in the
24 Git guide, section Cloning a repository. If you have done so already, pull the
26 #. Create a local git branch for your changes.
27 #. Update the required documents in the project repo(s).
28 #. Build the documentation with tox.
29 #. Check the output for errors.
30 #. Add the changed files.
31 #. Commit your changes. In the commit message, include the issue ID of the
32 JIRA task, e.g. Issue-ID:DOC-602
33 #. Request review with git review.
38 #. Go to the gerrit review's page included in the output of the git review
40 #. In gerrit, add the committers for the given
41 project. For more information, refer to the `Gerrit guide <https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#review>`_.
43 #. Implement comments by updating your patch, based on
44 `Updating an existing patch <https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#update-an-existing-patch>`_
48 If you already have the branch you need, skip the first 2 steps in the above