diff options
author | 2022-08-02 13:28:17 +0200 | |
---|---|---|
committer | 2022-08-04 11:51:51 +0200 | |
commit | 21d59414fca273aade30aa4209aca9bb35a5f78f (patch) | |
tree | bd1a7449fddb04204f3c759b2877b49f92fe6a17 /docs/guides/onap-developer/how-to-use-docs/update-review.rst | |
parent | 830bc298c26764f3d98f3ca98adf7b3c1b3d0a3a (diff) |
update and rearrange documentation related content
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/update-review.rst')
-rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/update-review.rst | 49 |
1 files changed, 0 insertions, 49 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/update-review.rst b/docs/guides/onap-developer/how-to-use-docs/update-review.rst deleted file mode 100644 index 3c3a0c037..000000000 --- a/docs/guides/onap-developer/how-to-use-docs/update-review.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _updates-and-review: - -Updates and Review -================== - -Most project owners will need only to concern themselves with their own -project documentation. However, documentation team members and certain -project owners will need to edit and test multiple documentation repositories. - -Updates -------- - -#. Create a JIRA task in the `ONAP JIRA <https://jira.onap.org/>`_ -before you start the updates. The created issue's ID will have to be added to -the commit message. - -.. note:: - The task should be created in the affected project's workspace. The release - should be specified, as well. - -#. If you have not cloned the repository yet, follow the instructions in the -Git guide, section Cloning a repository. If you have done so already, pull the -latest version. -#. Create a local git branch for your changes. -#. Update the required documents in the project repo(s). -#. Build the documentation with tox. -#. Check the output for errors. -#. Add the changed files. -#. Commit your changes. In the commit message, include the issue ID of the -JIRA task, e.g. Issue-ID:DOC-602 -#. Request review with git review. - - -Requesting Reviews ------------------- -#. Go to the gerrit review's page included in the output of the git review -command. -#. In gerrit, add the committers for the given -project. For more information, refer to the `Gerrit guide <https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#review>`_. - -#. Implement comments by updating your patch, based on -`Updating an existing patch <https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#update-an-existing-patch>`_ -in the Gerrit guide. - -.. note:: - If you already have the branch you need, skip the first 2 steps in the above - guide. |