fix rst / sphinx warnings

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
This commit is contained in:
Ryan Lercho 2023-12-05 07:58:50 +10:00
parent 978aa2d1b6
commit 206c08d237
2 changed files with 69 additions and 69 deletions

View file

@ -1,7 +1,7 @@
.. _solution:
Designing An Alternative Replacement
====
====================================
As Pagure Dist Git is a comprehensive service that is used by over ten other
infrastructure services - it is important to ensure that the replacement for
@ -20,7 +20,7 @@ or absence of certain desired features similar to those from the existing
production deployment must be taken as a coincidence.
Related services
----
----------------
The list of related services working alongside Pagure Dist Git are distributed
in two categories to mark whether they are maintained within the team or are
@ -34,13 +34,13 @@ changes introduced to keep up with the alternative.
:target: ../_images/dist_git_system.drawio.svg
Maintained by the team
^^^^
^^^^^^^^^^^^^^^^^^^^^^
1. **Monitor Gating**
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/monitorgating.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/monitorgating.html>`__.
Depending on the investigations performed on the Monitor Gating project,
changes can be introduced to the project to ensure that the compatibility is
maintained with the alternative chosen for Pagure Dist Git.
@ -49,7 +49,7 @@ Maintained by the team
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/hotness.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/hotness.html>`__.
Depending on the investigations performed on The New Hotness project,
changes can be introduced to the project to ensure that the compatibility is
maintained with the alternative chosen for Pagure Dist Git.
@ -58,7 +58,7 @@ Maintained by the team
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/releng.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/releng.html>`__.
Depending on the investigations performed on the Release Engineering
Scripts, changes can be introduced to the project to ensure that the
compatibility is maintained with the alternative chosen for Pagure Dist Git.
@ -67,7 +67,7 @@ Maintained by the team
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/toddlers.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/toddlers.html>`__.
Depending on the investigations performed on the Toddlers project and the
scripts used, changes can be introduced to the project to ensure that the
compatibility is maintained with the alternative chosen for Pagure Dist Git.
@ -76,7 +76,7 @@ Maintained by the team
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/notifications.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/notifications.html>`__.
Depending on the investigations performed on the Fedora Notifications
project, changes can be introduced to the project to ensure that the
compatibility is maintained with the alternative chosen for Pagure Dist Git.
@ -85,19 +85,19 @@ Maintained by the team
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/messaging.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/messaging.html>`__.
Depending on the investigations performed on the Fedora Messaging project,
changes can be introduced to the project to ensure that the compatibility is
maintained with the alternative chosen for Pagure Dist Git.
Maintained by other teams
^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^
1. **Fedpkg**
Information about the dependence of the project on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/fedpkg.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/fedpkg.html>`__.
Depending on the investigations performed on the Fedpkg project, changes can
be recommended to the project maintainers to ensure that the compatibility
is maintained with the alternative chosen for Pagure Dist Git.
@ -106,7 +106,7 @@ Maintained by other teams
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/copr.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/copr.html>`__.
Depending on the investigations performed on the COPR project, changes can
be recommended to the project maintainers to ensure that the compatibility
is maintained with the alternative chosen for Pagure Dist Git.
@ -115,7 +115,7 @@ Maintained by other teams
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/ci.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/ci.html>`__.
Depending on the investigations performed on the Fedora CI deployment,
changes can be recommended to the service maintainers to ensure that the
compatibility is maintained with the alternative chosen for Pagure Dist Git.
@ -124,7 +124,7 @@ Maintained by other teams
Information about the dependence of the service on the production deployment
of Pagure Dist Git can be found
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/ci.html>`_.
`here <https://fedora-arc.readthedocs.io/en/latest/dist-git-move/ci.html>`__.
Depending on the investigations performed on the Bodhi project, changes can
be recommended to the project maintainers to ensure that the compatibility
is maintained with the alternative chosen for Pagure Dist Git.
@ -138,7 +138,7 @@ Maintained by other teams
alternative chosen for Pagure Dist Git.
Interaction diagram
----
-------------------
The following illustration explains how the Pagure Dist Git alternative would
work alongside other infrastructure applications and services. The replacement
@ -146,7 +146,7 @@ would be a system chiefly consisting of three elements - **Messages Handler**,
**Dist Git Service** and **Compatibility Metaservice**.
Messages Handler
^^^^
^^^^^^^^^^^^^^^^
.. image:: ../_static/dist_git_system_msgh.drawio.svg
:target: ../_images/dist_git_system_msgh.drawio.svg
@ -168,7 +168,7 @@ here when implemented as then, this element would be reduced to being only a
special configuration of the said project.
Dist Git Service
^^^^
^^^^^^^^^^^^^^^^
.. image:: ../_static/dist_git_system_main.drawio.svg
:target: ../_images/dist_git_system_main.drawio.svg
@ -190,7 +190,7 @@ Also, having an HTTP API that allows for customizing its capabilities to match
those of Pagure Dist Git is necessary.
Compatibility Metaservice
^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: ../_static/dist_git_system_meta.drawio.svg
:target: ../_images/dist_git_system_meta.drawio.svg