Fix hardcoded extlinks link error in sphinx 4.4.0

governance doc job is failing because sphinx 4.4.0
raise error for hardcoded extlinks link
- https://github.com/sphinx-doc/sphinx/pull/9800

Warning, treated as error:
/home/zuul/src/opendev.org/openstack/governance/doc/source/goals/completed/pike/deploy-api-in-wsgi.rst:269:hardcoded link '6ef5fa9adc'

https://zuul.opendev.org/t/openstack/build/b84dd8d2989243bfa0cebee1a21dc4ff

we have 'repo' as extlinks
- 16302d8a2f/doc/source/conf.py (L50)

This fixes the hardcoded extlinks link and unblock the gate.

Change-Id: I61873080e0ebaa679fee191e1ae968a488bd637b
This commit is contained in:
Ghanshyam Mann 2022-01-19 00:03:31 -06:00
parent 16302d8a2f
commit b3e4cc67ec
14 changed files with 75 additions and 87 deletions

View File

@ -266,7 +266,7 @@ Planning Artifacts:
Completion Artifacts:
* `heat <https://opendev.org/openstack/heat/commit/6ef5fa9adc8886ed339132b5e5e27cee4000f762>`_
* :repo:`openstack/heat/commit/6ef5fa9adc8886ed339132b5e5e27cee4000f762`
horizon
-------
@ -329,7 +329,7 @@ Planning Artifacts:
Completion Artifacts:
* https://opendev.org/openstack/devstack/commit/a00e5f8810b6ca3b0b5d63cc228125e19bc91955
* :repo:`openstack/devstack/commit/a00e5f8810b6ca3b0b5d63cc228125e19bc91955`
kolla
-----

View File

@ -272,7 +272,7 @@ Planning Artifacts:
Completion Artifacts:
* https://opendev.org/openstack/cloudkitty/src/branch/master/setup.cfg#L19
* :repo:`openstack/cloudkitty/src/branch/master/setup.cfg#L19`
Community App Catalog
---------------------
@ -392,9 +392,9 @@ Planning Artifacts:
Completion Artifacts:
* `heat <https://opendev.org/openstack/heat/src/branch/master/setup.cfg#n19>`_
* `python-heatclient <https://opendev.org/openstack/python-heatclient/src/branch/master/setup.cfg#n21>`_
* `heat-translator <https://opendev.org/openstack/heat-translator/src/branch/master/setup.cfg#L20>`_
* :repo:`openstack/heat/src/branch/master/setup.cfg#n19`
* :repo:`openstack/python-heatclient/src/branch/master/setup.cfg#n21`
* :repo:`openstack/heat-translator/src/branch/master/setup.cfg#L20`
horizon
-------
@ -452,9 +452,9 @@ Planning Artifacts:
* https://bugs.launchpad.net/karbor/+bug/1681622
Completion Artifacts:
* `karbor classifier <https://opendev.org/openstack/karbor/src/branch/master/setup.cfg#L19>`_
* `karbor-dashboard classifier <https://opendev.org/openstack/karbor-dashboard/src/branch/master/setup.cfg#L19>`_
* `python-karborclient classifier <https://opendev.org/openstack/python-karborclient/src/branch/master/setup.cfg#L19>`_
* :repo:`openstack/karbor/src/branch/master/setup.cfg#L19`
* :repo:`openstack/karbor-dashboard/src/branch/master/setup.cfg#L19`
* :repo:`openstack/python-karborclient/src/branch/master/setup.cfg#L19`
* `python 3 jobs <https://review.opendev.org/302072/>`_
keystone
@ -467,10 +467,10 @@ Planning Artifacts:
Completion Artifacts:
* `keystone <https://opendev.org/openstack/keystone/src/branch/master/setup.cfg#L19>`_
* `keystonemiddleware <https://opendev.org/openstack/keystonemiddleware/src/branch/master/setup.cfg#L19>`_
* `python-keystoneclient <https://opendev.org/openstack/python-keystoneclient/src/branch/master/setup.cfg#L19>`_
* `keystoneauth <https://opendev.org/openstack/keystoneauth/src/branch/master/setup.cfg#L19>`_
* :repo:`openstack/keystone/src/branch/master/setup.cfg#L19`
* :repo:`openstack/keystonemiddleware/src/branch/master/setup.cfg#L19`
* :repo:`openstack/python-keystoneclient/src/branch/master/setup.cfg#L19`
* :repo:`openstack/keystoneauth/src/branch/master/setup.cfg#L19`
kolla
-----
@ -495,7 +495,7 @@ Planning Artifacts:
Completion Artifacts:
* `kuryr <https://opendev.org/openstack/kuryr/src/branch/master/setup.cfg#L19>`_
* :repo:`openstack/kuryr/src/branch/master/setup.cfg#L19`
magnum
------
@ -541,10 +541,10 @@ Planning Artifacts:
Completion Artifacts:
* `murano <https://opendev.org/openstack/murano/src/branch/master/setup.cfg#L36>`_
* `murano-dashboard <https://opendev.org/openstack/murano-dashboard/src/branch/master/setup.cfg#L41>`_
* `murano-agent <https://opendev.org/openstack/murano-agent/src/branch/master/setup.cfg#L21>`_
* `python-muranoclient <https://opendev.org/openstack/python-muranoclient/src/branch/master/setup.cfg#L23>`_
* :repo:`openstack/murano/src/branch/master/setup.cfg#L36`
* :repo:`openstack/murano-dashboard/src/branch/master/setup.cfg#L41`
* :repo:`openstack/murano-agent/src/branch/master/setup.cfg#L21`
* :repo:`openstack/python-muranoclient/src/branch/master/setup.cfg#L23`
neutron
-------
@ -619,11 +619,11 @@ Planning Artifacts:
Completion Artifacts:
* `cliff <https://opendev.org/openstack/cliff/src/branch/master/setup.cfg#L15>`_
* `openstackclient <https://opendev.org/openstack/openstackclient/src/branch/master/setup.cfg#L20>`_
* `os-client-config <https://opendev.org/openstack/os-client-config/src/branch/master/setup.cfg#L19>`_
* `osc-lib <https://opendev.org/openstack/osc-lib/src/branch/master/setup.cfg#L19>`_
* `python-openstackclient <https://opendev.org/openstack/python-openstackclient/src/branch/master/setup.cfg#L19>`_
* :repo:`openstack/cliff/src/branch/master/setup.cfg#L15`
* :repo:`openstack/openstackclient/src/branch/master/setup.cfg#L20`
* :repo:`openstack/os-client-config/src/branch/master/setup.cfg#L19`
* :repo:`openstack/osc-lib/src/branch/master/setup.cfg#L19`
* :repo:`openstack/python-openstackclient/src/branch/master/setup.cfg#L19`
oslo
----
@ -720,7 +720,7 @@ Planning Artifacts:
Completion Artifacts:
* https://opendev.org/openstack/searchlight/src/branch/master/setup.cfg#L19
* :repo:`openstack/searchlight/src/branch/master/setup.cfg#L19`
Security
--------
@ -746,9 +746,9 @@ Planning Artifacts:
Completion Artifacts:
* `solum <https://opendev.org/openstack/solum/src/branch/master/setup.cfg#L20>`_
* `python-solumclient <https://opendev.org/openstack/python-solumclient/src/branch/master/setup.cfg#L19>`_
* `solum-dashboard <https://opendev.org/openstack/solum-dashboard/src/branch/master/setup.cfg#L13>`_
* :repo:`openstack/solum/src/branch/master/setup.cfg#L20`
* :repo:`openstack/python-solumclient/src/branch/master/setup.cfg#L19`
* :repo:`openstack/solum-dashboard/src/branch/master/setup.cfg#L13`
Stable branch maintenance
-------------------------
@ -999,7 +999,7 @@ Planning Artifacts:
Completion Artifacts:
* Classifier: https://opendev.org/openstack/zun/src/branch/master/setup.cfg
* :repo:`openstack/zun/src/branch/master/setup.cfg`
* Unit tests: All unit tests are passed in python 3.5. There is a voting check and gate job setup called 'gate-zun-python35'.
* Functional tests: Zun doesn't have functional tests.
* Integration tests: All integration tests are passed in python 3.5. There is a voting check and gate job setup: https://review.opendev.org/#/c/491623/

View File

@ -316,7 +316,7 @@ Completion Artifacts:
The Designate team was already compliant before that the goal was defined.
Here is the tempest plugin repo:
https://opendev.org/openstack/designate-tempest-plugin
:repo:`openstack/designate-tempest-plugin`
Documentation
-------------
@ -405,7 +405,7 @@ Completion Artifacts:
The Horizon team was already compliant before that the goal was defined. Here
is the tempest plugin repo:
https://opendev.org/openstack/tempest-horizon
:repo:`openstack/tempest-horizon`
I18n
----
@ -472,7 +472,7 @@ Completion Artifacts:
The following review removed the tempest plugin that keystone was maintaining
in tree and links to the new repository the plugin was moved to:
https://opendev.org/openstack/keystone/commit/6f4e37e9e6810e24f45d034261f4a6ec4aa85fb1
:repo:`openstack/keystone/commit/6f4e37e9e6810e24f45d034261f4a6ec4aa85fb1`
kolla
-----
@ -497,7 +497,7 @@ Completion Artifacts:
The kuryr team is maintaining its tempest plugin in a separate repo:
https://opendev.org/openstack/kuryr-tempest-plugin
:repo:`openstack/kuryr-tempest-plugin`
loci
----
@ -586,7 +586,7 @@ Completion Artifacts:
The murano team is maintaining its tempest plugin in a separate repo:
https://opendev.org/openstack/murano-tempest-plugin
:repo:`openstack/murano-tempest-plugin`
neutron
-------
@ -791,7 +791,7 @@ Completion Artifacts:
The Sahara team was already compliant before that the goal was defined. Here
is the commit link for the same:
https://opendev.org/openstack/sahara/commit/83a6a2868377dd61530a9de80c6ca49061c5f248
:repo:`openstack/sahara/commit/83a6a2868377dd61530a9de80c6ca49061c5f248`
searchlight
-----------
@ -847,7 +847,7 @@ Completion Artifacts:
The solum team is maintaining its tempest plugin in a separate repo:
https://opendev.org/openstack/solum-tempest-plugin
:repo:`openstack/solum-tempest-plugin`
Stable branch maintenance
-------------------------
@ -939,7 +939,7 @@ Completion Artifacts:
The tripleo team is maintaining its tempest plugin in a separate repo for
testing tripleo workflows:
https://opendev.org/openstack/tripleo-common-tempest-plugin
:repo:`openstack/tripleo-common-tempest-plugin`
trove
-----
@ -984,7 +984,7 @@ Completion Artifacts:
The following review removed the tempest plugin that watcher was maintaining
in tree and links to the new repository the plugin was moved to:
https://opendev.org/openstack/watcher/commit/0c4b439c5ea1206263f39c118daf6d2ff1422480
:repo:`openstack/watcher/commit/0c4b439c5ea1206263f39c118daf6d2ff1422480`
winstackers
-----------
@ -997,7 +997,7 @@ Completion Artifacts:
The Winstackers team is maintaining its tempest plugin in a separate repo:
https://opendev.org/openstack/oswin-tempest-plugin
:repo:`openstack/oswin-tempest-plugin`
zaqar
-----
@ -1021,4 +1021,4 @@ Completion Artifacts:
The Zun team is maintaining its tempest plugin in a separate repo:
https://opendev.org/openstack/zun-tempest-plugin
:repo:`openstack/zun-tempest-plugin`

View File

@ -94,12 +94,10 @@ References
==========
The Nova project has already implemented a ``nova-status upgrade check``
command along with several checkers. The `command source
<https://opendev.org/openstack/nova/src/commit/a1f3a5946ab703225a74f8e85a068cb4fb20e2ff/nova/cmd/status.py>`__
command along with several checkers. The :repo:`openstack/nova/src/commit/a1f3a5946ab703225a74f8e85a068cb4fb20e2ff/nova/cmd/status.py`
may be useful as a reference.
The `original commit
<https://opendev.org/openstack/nova/commit/a1f3a5946ab703225a74f8e85a068cb4fb20e2ff>`__
The :repo:`openstack/nova/commit/a1f3a5946ab703225a74f8e85a068cb4fb20e2ff`
adding the checker framework may also be useful.
The `Command Line Reference

View File

@ -122,7 +122,7 @@ support on that project's devstack-plugin. One example of missing this setting
is in senlin's devstack plugin (as of drafting this goal) which directly use
``HOST_IP`` as listen address so setting the ``SERVICE_IP_VERSION=6`` does not
make senlin to listen on IPv6
- https://opendev.org/openstack/senlin/src/commit/f4a00ff076df16591ef3cd073f51f42405d2c34c/devstack/lib/senlin#L44
- :repo:`openstack/senlin/src/commit/f4a00ff076df16591ef3cd073f51f42405d2c34c/devstack/lib/senlin#L44`
Gate jobs for IPv6-only setting
@ -144,16 +144,13 @@ Gate jobs for IPv6-only setting
References
==========
Devstack has `base job
<https://opendev.org/openstack/devstack/src/branch/master/.zuul.yaml#L486>`__
Devstack has :repo:`openstack/devstack/src/branch/master/.zuul.yaml#L486`
ready to use.
Tempest run the `Tempest IPv6 job
<https://opendev.org/openstack/tempest/src/branch/master/.zuul.yaml#L175>`__
Tempest run the :repo:`openstack/tempest/src/branch/master/.zuul.yaml#L175`
running but as non voting.
Oslo utils common `netutils
<https://opendev.org/openstack/oslo.utils/src/branch/master/oslo_utils/netutils.py>`__
Oslo utils common :repo:`openstack/oslo.utils/src/branch/master/oslo_utils/netutils.py`
to use for IPv6 settings and checks.
Reference of this goal idea in `community-goals

View File

@ -66,9 +66,9 @@ References
#. `Contributor Guide <https://docs.openstack.org/contributors/code-and-documentation/index.html>`_
#. `Cookie Cutter doc/source/contributor/contributing.rst Template <https://opendev.org/openstack/cookiecutter/raw/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/doc/source/contributor/contributing.rst>`_
#. :repo:`openstack/cookiecutter/raw/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/doc/source/contributor/contributing.rst`
#. `Cookie Cutter CONTRIBUTING.rst Template <https://opendev.org/openstack/cookiecutter/raw/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/CONTRIBUTING.rst>`_
#. :repo:`openstack/cookiecutter/raw/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/CONTRIBUTING.rst`
#. `Nova PTL Guide <https://docs.openstack.org/nova/latest/contributor/ptl-guide.html>`_

View File

@ -127,8 +127,7 @@ In fact finalizing the effort on Zuul v3 was considered part of the goal,
while still moving forward with all the other non-Grenade conversions.
As expected, porting most Grenade jobs should now be trivial.
While cleaning the legacy jobs from `openstack-zuul-jobs
<https://opendev.org/openstack/openstack-zuul-jobs.git>`_ and
`project-config <https://opendev.org/openstack/project-config.git>`_
While cleaning the legacy jobs from :repo:`openstack/openstack-zuul-jobs.git` and
:repo:`openstack/project-config.git`
is not part of the completion criteria, achieving the stretch goal
would reduce the amount of items to track in those repositories.

View File

@ -128,9 +128,9 @@ These are the projects still using oslo.rootwrap that should migrate:
Links
=====
.. [1] https://opendev.org/openstack/hacking/src/branch/master/hacking/checks/imports.py
.. [1] :repo:`openstack/hacking/src/branch/master/hacking/checks/imports.py`
.. [2] https://docs.openstack.org/oslo.privsep/latest/user/index.html
.. [3] https://opendev.org/openstack/oslo.privsep/src/tag/2.1.1/oslo_privsep/priv_context.py#L216
.. [3] :repo:`openstack/oslo.privsep/src/tag/2.1.1/oslo_privsep/priv_context.py#L216`
.. [4] https://review.opendev.org/#/q/project:openstack/nova+branch:master+topic:my-own-personal-alternative-universe
.. [5] https://review.opendev.org/#/q/status:merged+project:openstack/neutron+branch:master+topic:bug/1492714
.. [6] https://review.opendev.org/#/c/287725/

View File

@ -94,9 +94,9 @@ TC Repos
While your main focus as a TC member is the governance repo, the complete list
of repos that are under the governance of the TC is listed below:
* `governance/reference/technical-committee-repos.yaml <https://opendev.org/openstack/governance/raw/branch/master/reference/technical-committee-repos.yaml>`_.
* :repo:`openstack/governance/raw/branch/master/reference/technical-committee-repos.yaml`.
* `governance/reference/user-committee-repos.yaml <https://opendev.org/openstack/governance/raw/branch/master/reference/user-committee-repos.yaml>`_.
* :repo:`openstack/governance/raw/branch/master/reference/user-committee-repos.yaml`.
The `TC review dashboard
<https://review.opendev.org/#/dashboard/?title=Technical+Committee+Inbox&foreach=project%3Aopenstack%2Fgovernance+is%3Aopen&My+proposals=owner%3Aself&Formal+Vote+Items+I+have+not+voted+on+yet=topic%3Aformal-vote+NOT+(+label%3ARollCall-Vote%2B1%2Cself+OR+label%3ARollCall-Vote-1%2Cself+)&Has+at+Least+One+Objection=(+label%3ARollCall-Vote%3C%3D-1+OR+label%3ACode-Review%3C%3D-1+)&Quickies=(+topic%3Atypo-fix+OR+topic%3Acode-change+OR+topic%3Adocumentation-change+OR+topic%3Aproject-update+)&Formal+Vote+Items=topic%3Aformal-vote&Goal+Items+I+Haven't+Voted+On=path%3A^goals%2F.*+NOT+(+label%3ARollCall-Vote%2B1%2Cself+OR+label%3ARollCall-Vote-1%2Cself+)&I+Haven't+Voted+on+this+Draft=NOT+(+label%3ARollCall-Vote%2B1%2Cself+OR+label%3ARollCall-Vote-1%2Cself+)&Everything=>`_

View File

@ -5,8 +5,7 @@
Introduction
------------
Since the inception of the `cross-project specification repository
<https://opendev.org/openstack/openstack-specs>`_ the Technical
Since the inception of the :repo:`openstack/openstack-specs` the Technical
Committee has had privileges in OpenStack's gerrit review system to +2
a specification, as oppose to a +1 which any individual member of the community
can give today.

View File

@ -24,7 +24,7 @@ Updated Resolution
Whereas the Trademark Program has made it clear that they have the tooling and
willingness to support trademark tests located in any of
* The `Tempest repository`_
* The :repo:`openstack/tempest`
* Project specific tempest plugins (e.g., `image-trademark-tempest-plugin`)
* Vertical specific tempest plugins (e.g.,
`nfv-vertical-trademark-tempest-plugin`)
@ -44,8 +44,8 @@ projects should live in one, and only one, of four possible locations, each
with differing strategies for review and repository ownership (status in
:ref:`projects`):
* The `Tempest repository`_, with approval reviews performed by the QA Team,
repository ownership via the QA Team (already true).
* The :repo:`openstack/tempest`, with approval reviews
performed by the QA Team, repository ownership via the QA Team (already true).
* A vertical specific tempest plugin, with approval reviews performed by the QA
Team and the Trademark Program, repository ownership via the Trademark
Program.
@ -70,4 +70,3 @@ and the Trademark Program.
to produce tests that are run by tempest.
.. _gabbi: https://gabbi.readthedocs.io/
.. _Tempest repository: https://opendev.org/openstack/tempest

View File

@ -11,20 +11,18 @@ changes. This act is known as **repository retirement**.
When a repository which was governed by the OpenStack Technical
Committee ceases to be its responsibility any longer, the
deliverable repository entry in the official `list of projects
<https://opendev.org/openstack/governance/src/branch/master/reference/projects.yaml>`_
is moved to a `legacy projects list
<https://opendev.org/openstack/governance/src/branch/master/reference/legacy.yaml>`_
deliverable repository entry in the official
:repo:`openstack/governance/src/branch/master/reference/projects.yaml`
is moved to a :repo:`openstack/governance/src/branch/master/reference/legacy.yaml`
with its proximate ``retired-on`` date recorded. This act is known
as **governance removal**.
Following conclusion of the *Train* development cycle, any new
**governance removal** for a repository in the `openstack Git namespace
of OpenDev <https://opendev.org/openstack/>`_ must undergo
**repository retirement** even if development will be continuing in
another Git namespace on OpenDev. The OpenStack Technical Committee
may defer this requirement if responsibility over the repository is
being transferred to another official OpenStack governance body with
**governance removal** for a repository in the :repo:`openstack/`
must undergo **repository retirement** even if development will be
continuing in another Git namespace on OpenDev. The OpenStack Technical
Committee may defer this requirement if responsibility over the repository
is being transferred to another official OpenStack governance body with
which it shares the ``openstack`` Git namespace on OpenDev (for
example, a recognized `OpenStack special interest group
<https://governance.openstack.org/sigs/>`_ or `OpenStack User

View File

@ -42,15 +42,16 @@ Required roles
The project teams are expected to have at least the following required liaison
roles:
* Release liaison: The `release liaison`_ is responsible for requesting releases
for deliverables produced by the project team. In addition, release liaisons
generally review requests for Feature Freeze Exception (FFE).
* Release liaison: The :repo:`openstack/releases/src/branch/master/data/release_liaisons.yaml`
is responsible for requesting releases for deliverables produced by the
project team. In addition, release liaisons generally review requests for
Feature Freeze Exception (FFE).
* tact-sig liaison: Historically named the "infra Liaison". It is responsible for
the health of the CI jobs run in the OpenStack Zuul CI. In the event that there
is an issue with those jobs, this liaison will be a point of contact for the
`TaCT SIG`_. Also, a +1 from at least one tact-sig liaison will be required
for changes in the `project_config repository`_.
for changes in the :repo:`openstack/project-config`.
* Security liaison: the security liaison is the contact person to help assessing
the impact of any security reported issues in the project team deliverables,
@ -178,9 +179,9 @@ Once a project team has moved to the distributed leadership model, they can
revert to the PTL model by creating a change to `projects.yaml` to remove the
"leadership_type: distributed" line in the team's configuration. This change
should have at least a +1 from all the people currently serving as liaisons,
including the `release liaison`_ for the project team, which might not be in the
`governance` repo. It must also get a +1 from the future PTL, listed in the
same change.
including the :repo:`openstack/releases/src/branch/master/data/release_liaisons.yaml`
for the project team, which might not be in the `governance` repo.
It must also get a +1 from the future PTL, listed in the same change.
A project team may change their opt-in status only once a release cycle, to
ensure that the elections officials have clarity on which project teams need PTL
@ -193,7 +194,5 @@ team and its deliverables, with now an extra option
convert the project to a distributed leadership with the help of the project
team members.
.. _release liaison: https://opendev.org/openstack/releases/src/branch/master/data/release_liaisons.yaml
.. _TaCT SIG: https://governance.openstack.org/sigs/tact-sig.html
.. _project_config repository: https://opendev.org/openstack/project-config
.. _PTL page on the project team guide: https://docs.openstack.org/project-team-guide/ptl.html

View File

@ -46,8 +46,8 @@ For all of these reasons, the OpenStack community will benefit from
having the interoperability tests used by DefCore in a central
location. The TC therefore encourages the DefCore committee to
consider it an indication of future technical direction that we do not
want tests outside of the `Tempest repository`_ used for trademark
enforcement, and that any new or existing tests that cover
want tests outside of the :repo:`openstack/tempest`
used for trademark enforcement, and that any new or existing tests that cover
capabilities they want to consider for trademark enforcement should be
placed in Tempest.
@ -68,5 +68,4 @@ teams should collaborate to ensure that those tests are identified and
implemented in a suitable way.
.. _QA, DefCore, and interoperability testing: https://etherpad.openstack.org/p/newton-qa-defcore-and-interoperability
.. _Tempest repository: https://opendev.org/openstack/tempest
.. _scope of what they consider suitable for Tempest: https://wiki.openstack.org/wiki/QA/Tempest-test-removal#Tempest_Scope