Skip to content

Commit

Permalink
Fix loose ends in documentation after renaming plugin hrefs (teemtee#…
Browse files Browse the repository at this point in the history
…3115)

Hopefully a wrap up of teemtee#3104
  • Loading branch information
happz authored and The-Mule committed Oct 14, 2024
1 parent 776fce8 commit 6c343af
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -362,17 +362,17 @@ parts, to highlight important points, or to provide helpful examples.
A couple of best practices when updating documentation:

* When referring to a plugin, its options or documentation, prefer
reference to ``plugins/STEP/PLUGIN`` rather than to older
reference to ``/plugins/STEP/PLUGIN`` rather than to older
``/spec/plans/STEP/PLUGIN``:

.. code-block:: rest
# This is good:
:ref:`plugins/prepare/ansible`
:ref:`/plugins/prepare/ansible`
# If the user-facing plugin name differs from the Python one,
# or if you need capitalize the first letter:
:ref:`Beaker<plugins/provision/beaker>`
:ref:`Beaker</plugins/provision/beaker>`
# This should be avoided:
:ref:`/spec/plans/prepare/ansible`
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/provision-header.inc.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _plugins/provision/hard-reboot:
.. _/plugins/provision/hard-reboot:

Hard reboot
-----------
Expand Down
2 changes: 1 addition & 1 deletion spec/tests/restart.fmf
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ description: |

Be aware that this feature may be limited depending on how
the guest was provisioned. See
:ref:`plugins/provision/hard-reboot`.
:ref:`/plugins/provision/hard-reboot`.

.. versionadded:: 1.33

Expand Down
2 changes: 1 addition & 1 deletion tmt/checks/watchdog.py
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ class Watchdog(CheckPlugin[WatchdogCheck]):
.. warning::
Be aware that this feature may be limited depending on how the
guest was provisioned. See :ref:`plugins/provision/hard-reboot`.
guest was provisioned. See :ref:`/plugins/provision/hard-reboot`.
Each probe has a "budget" of allowed failures, and when it runs out,
the action is taken. A successful probe replenishes its budget to
Expand Down

0 comments on commit 6c343af

Please sign in to comment.