Merge "[contrib] Update review dashboard, CI references, etc."
This commit is contained in:
commit
c10d5f0d66
doc/doc-contrib-guide/source
@ -12,10 +12,10 @@ Reviewing documentation
|
||||
OpenStack documentation is treated in the same way as code, and follows the
|
||||
standard code review process. To see what documentation changes are ready for
|
||||
review, use the `Documentation Program Dashboard
|
||||
<http://is.gd/openstackdocsreview>`_. It is organized in groups based on the
|
||||
audience for the documentation. To see current proposed changes, make sure
|
||||
you register and log into https://review.openstack.org. For more details on
|
||||
the review process, see `Code Review
|
||||
<https://is.gd/openstackdocsreviewreloaded>`_. It is organized in groups based
|
||||
on the audience for the documentation. To see current proposed changes, make
|
||||
sure you register and log into https://review.openstack.org. For more details
|
||||
on the review process, see `Code Review
|
||||
<https://docs.openstack.org/infra/manual/developers.html#code-review>`_.
|
||||
|
||||
Repositories and core team
|
||||
@ -32,8 +32,8 @@ special rules apply:
|
||||
* security-doc: has a separate core team consisting of Docs team members and
|
||||
Security team members. The rule here is that each patch needs an approval
|
||||
by a Docs core and a Security core.
|
||||
* training-guides and training-labs: have separate core teams, but also
|
||||
includes the openstack-manuals core team.
|
||||
* contributor-guide, training-guides and training-labs: have separate core
|
||||
teams, but also includes the openstack-manuals core team.
|
||||
|
||||
The current list of docs cores for openstack-manuals can be found at
|
||||
`Group openstack-doc-core
|
||||
@ -49,19 +49,18 @@ and `Code Review Guidelines
|
||||
Once done, follow the steps below to submit a patch review.
|
||||
|
||||
#. Go to the `Documentation Program Dashboard
|
||||
<http://is.gd/openstackdocsreview>`_.
|
||||
<https://is.gd/openstackdocsreviewreloaded>`_.
|
||||
#. Select a patch set.
|
||||
#. Click a file that was uploaded to view the changes side by side.
|
||||
#. If you see some inconsistencies or have questions to the patch owner,
|
||||
you can also highlight the line or word in question, and press 'c'
|
||||
on your keyboard, which enables commenting directly on that line or word.
|
||||
Click :guilabel:`Save` button once you write a draft of your comment.
|
||||
#. In the :guilabel:`Jenkins check` section, click the ``checkbuild``
|
||||
#. In the :guilabel:`Zuul check` section, click the ``checkbuild``
|
||||
gate link (for the openstack-manuals, it is called
|
||||
``gate-openstack-manuals-tox-doc-publish-checkbuild``) and review the
|
||||
built manuals to see how the change will look on the web page. For a new
|
||||
patch, it takes some time before the OpenStack CI system checks appear on
|
||||
the Gerrit page.
|
||||
``build-tox-manuals-checkbuild``) and review the built manuals to see how
|
||||
the change will look on the web page. For a new patch, it takes some time
|
||||
before the OpenStack CI system checks appear on the Gerrit page.
|
||||
You can also :ref:`build the patch locally <docs_builds_locally>`
|
||||
if necessary.
|
||||
#. Click :guilabel:`Reply` to vote and enter any comments about your review,
|
||||
@ -100,13 +99,10 @@ recognizing valuable team members.
|
||||
The process is:
|
||||
|
||||
* Every month (usually on the 1st), the documentation PTL draws the top 12
|
||||
names using these reports:
|
||||
names from the `Stackalytics <http://stackalytics.com/>`_ report for
|
||||
openstack-manuals:
|
||||
|
||||
* `Reviews for the last 30 days
|
||||
<http://russellbryant.net/openstack-stats/docs-reviewers-30.txt>`_
|
||||
* `Reviews for the last 90 days
|
||||
<http://russellbryant.net/openstack-stats/docs-reviewers-90.txt>`_
|
||||
* `Openstack Manuals stackalytics
|
||||
* `openstack-manuals Stackalytics
|
||||
<http://stackalytics.com/?module=openstack-manuals&metric=commits>`_
|
||||
|
||||
* The PTL then consults the existing core team with a list of names to be
|
||||
|
@ -113,15 +113,6 @@ For the instructions on how to set up a repository so that you can work
|
||||
on it locally, refer to the `Starting Work on a New Project`_
|
||||
of the Infrastructure manual.
|
||||
|
||||
.. note::
|
||||
|
||||
Substitute ``<projectname>`` in the examples included in this section
|
||||
with ``openstack-manuals`` as the documentation is mostly stored in
|
||||
the *openstack-manuals* repository. However, if you need specific
|
||||
guide sources, refer to *openstack/api-site*,
|
||||
*openstack/security-guide*, or *openstack/training-guides*
|
||||
repository.
|
||||
|
||||
See :ref:`troubleshoot_setup` if you have difficulty with a repository
|
||||
setup.
|
||||
|
||||
@ -156,7 +147,7 @@ Committing a change
|
||||
|
||||
https://review.openstack.org/<COMMIT-NUMBER>
|
||||
|
||||
#. In Gerrit, wait for the automatic Jenkins checks to succeed.
|
||||
#. In Gerrit, wait for the automatic Zuul checks to succeed.
|
||||
|
||||
Celebrate and wait for reviews!
|
||||
|
||||
@ -295,7 +286,7 @@ git and git review
|
||||
`Resolving merge conflicts after a git rebase
|
||||
<https://help.github.com/articles/resolving-merge-conflicts-after-a-git-rebase/>`_.
|
||||
|
||||
* ``FAILURE`` in the ``Jenkins check`` section of your commit in Gerrit
|
||||
* ``FAILURE`` in the ``Zuul check`` section of your commit in Gerrit
|
||||
|
||||
#. Click the link next to the ``FAILURE`` test.
|
||||
#. Verify the output of the :file:`console.html`:
|
||||
|
@ -11,7 +11,7 @@ to ensure quality and accuracy of documentation.
|
||||
The OpenStack community has the following documentation subteams
|
||||
with their respective leads:
|
||||
|
||||
* :doc:`API <api-guides>`: Anne Gentle
|
||||
* :doc:`api-site <api-guides>`: *vacant*
|
||||
* `Contributor Guide
|
||||
<https://docs.openstack.org/contributors/>`_:
|
||||
Mike Perez
|
||||
@ -27,8 +27,8 @@ with their respective leads:
|
||||
The current list of docs cores for openstack-manuals, openstackdocstheme,
|
||||
and openstack-doc-tools repositories can be found at
|
||||
https://review.openstack.org/#/admin/groups/30,members.
|
||||
The api-site, docs-specs, security-doc, training-guides, and training-labs
|
||||
repositories have separate core teams.
|
||||
The api-site, contributor-guide, docs-specs, security-doc, training-guides,
|
||||
and training-labs repositories have separate core teams.
|
||||
|
||||
The cross-project liaisons (CPLs) assist with subject matter questions,
|
||||
reviews, doc bug triaging, and patching docs.
|
||||
|
Loading…
x
Reference in New Issue
Block a user