Skip to content

Commit dbae0ce

Browse files
fix label warnings (#2417)
* fix broken links * fix some more label problems * Apply suggestions from code review Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]>
1 parent 20511dd commit dbae0ce

File tree

13 files changed

+23
-22
lines changed

13 files changed

+23
-22
lines changed

docs/docsite/rst/ansible_index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ Contributors develop and change modules and plugins, hosted in collections, much
6363
:caption: Common Ansible Scenarios
6464

6565
scenario_guides/cloud_guides
66-
scenario_guides/network_guides
6766

6867
.. toctree::
6968
:maxdepth: 2

docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The following guidelines describe the required infrastructure for your collectio
105105
Python Compatibility
106106
====================
107107

108-
In addition to the Python requirements specified in this section, collections SHOULD adhere to the tips at :ref:`ansible-and-python-3`.
108+
In addition to the Python requirements specified in this section, collections SHOULD adhere to the tips at :ref:`ansible_and_python_3`.
109109

110110
.. _coll_python_reqs:
111111

@@ -227,19 +227,19 @@ Other directories
227227
.. _coll_docs_structure_reqs:
228228

229229
Documentation requirements
230-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
230+
~~~~~~~~~~~~~~~~~~~~~~~~~~
231231

232232
Collections:
233233

234-
* ``MUST`` use :ref:`links and formatting macros <linking-and-other-format-macros-within-module-documentation>`.
234+
* ``MUST`` use :ref:`links and formatting macros <module_documents_linking>`.
235235
* ``SHOULD`` have contributor guidelines in the ``CONTRIBUTING.md`` or ``README.md`` file.
236236

237237
All modules and plugins:
238238

239-
* ``MUST`` include a :ref:`DOCUMENTATION <documentation-block>` block.
240-
* ``MUST`` include an :ref:`EXAMPLES <examples-block>` block (except where not relevant for the plugin type).
239+
* ``MUST`` include a :ref:`DOCUMENTATION <documentation_block>` block.
240+
* ``MUST`` include an :ref:`EXAMPLES <examples_block>` block (except where not relevant for the plugin type).
241241
* ``MUST`` use FQCNs when referring to modules, plugins and documentation fragments inside and outside the collection including ``ansible.builtin.`` for ansible-core.
242-
* ``MUST`` include a :ref:`RETURN <return-block>` block for modules and other plugins that return data.
242+
* ``MUST`` include a :ref:`RETURN <return_block>` block for modules and other plugins that return data.
243243
* ``MUST`` include the ``version_added`` field when adding new content to an existing collection for entities that support it, for example, for modules, plugins, options, return values, and attributes.
244244

245245
* You do not have to add ``version_added`` when creating a new collection before its first release.
@@ -326,7 +326,7 @@ Module naming
326326
* Modules that only gather and return information MUST be named ``<something>_info``.
327327
* Modules that gather and return ``ansible_facts`` MUST be named ``<something>_facts`` and MUST NOT return anything but facts.
328328

329-
For more information, refer to the :ref:`Developing modules guidelines <creating-an-info-or-a-facts-module>`.
329+
For more information, refer to the :ref:`Developing modules guidelines <creating_info_facts>`.
330330

331331
.. _coll_licensing_req:
332332

@@ -427,8 +427,8 @@ To receive important announcements that can affect the collections (for example,
427427

428428
* Collections MUST run an equivalent of the ``ansible-test sanity --docker`` command.
429429

430-
* If they do not use ``--docker``, they must make sure that all tests run, in particular the compile and import tests (which should run for all :ref:`supported Python versions <ansible-and-python-3>`).
431-
* Collections can choose to skip certain Python versions that they explicitly do not support; this needs to be documented in ``README.md`` and in every module and plugin (hint: use a docs fragment). However, we strongly recommend you follow the :ref:`Ansible Python Compatibility <ansible-and-python-3>` section for more details.
430+
* If they do not use ``--docker``, they must make sure that all tests run, in particular the compile and import tests (which should run for all :ref:`supported Python versions <ansible_and_python_3>`).
431+
* Collections can choose to skip certain Python versions that they explicitly do not support; this needs to be documented in ``README.md`` and in every module and plugin (hint: use a docs fragment). However, we strongly recommend you follow the :ref:`Ansible Python Compatibility <ansible_and_python_3>` section for more details.
432432

433433
* You SHOULD *additionally* run ``ansible-test sanity`` from the ansible/ansible ``devel`` branch so that you find out about new linting requirements earlier.
434434
* The sanity tests MUST pass.
@@ -493,10 +493,10 @@ Development conventions
493493
All modules in your collection:
494494

495495
* MUST satisfy all the requirements listed in the :ref:`module_dev_conventions`.
496-
* MUST satisfy the concept of :ref:`idempotency <term-Idempotency>`: if a module repeatedly runs with the same set of inputs, it will not make any changes on the system.
496+
* MUST satisfy the concept of :term:`idempotency <Idempotency>`: if a module repeatedly runs with the same set of inputs, it will not make any changes on the system.
497497
* MUST NOT query information using special ``state`` option values like ``get``, ``list``, ``query``, or ``info`` -
498-
create new ``_info`` or ``_facts`` modules instead (for more information, refer to the :ref:`Developing modules guidelines <creating-an-info-or-a-facts-module>`).
499-
* ``check_mode`` MUST be supported by all ``*_info`` and ``*_facts`` modules (for more information, refer to the :ref:`Development conventions <#following-ansible-conventions>`).
498+
create new ``_info`` or ``_facts`` modules instead (for more information, refer to the :ref:`Developing modules guidelines <creating_info_facts>`).
499+
* ``check_mode`` MUST be supported by all ``*_info`` and ``*_facts`` modules (for more information, refer to the :ref:`Development conventions <developing_modules_best_practices>`).
500500

501501
.. _coll_dependencies:
502502

docs/docsite/rst/community/maintainers_guidelines.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ See the :ref:`Communication guide <communication_irc>` to learn more about real-
7070
Community Topics
7171
----------------
7272

73-
The Community and the :ref:`Steering Committee <steering_responsibilitie>` asynchronously discuss and vote on the :ref:`community topics<creating_community_topic>` which impact the whole project or its parts including collections and packaging.
73+
The Community and the :ref:`Steering Committee <steering_responsibilities>` asynchronously discuss and vote on the :ref:`community topics<creating_community_topic>` which impact the whole project or its parts including collections and packaging.
7474

7575
Share your opinion and vote on the topics to help the community make the best decisions.
7676

docs/docsite/rst/community/steering/community_steering_committee.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Depending on a topic you want to discuss with the Community and the Committee, a
101101
* `Ansible Collection Inclusion Checklist <https://github.com/ansible-collections/ansible-inclusion/blob/main/collection_checklist.md>`_.
102102
* :ref:`removal_from_ansible`.
103103

104-
.. _community_topics_workflow:
104+
.. _community_topics_sc:
105105

106106
Community topics workflow
107107
^^^^^^^^^^^^^^^^^^^^^^^^^

docs/docsite/rst/dev_guide/ansible_index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Find the task that best describes what you want to do:
3737
* a :ref:`network module <developing_modules_network>`
3838
* a :ref:`Windows module <developing_modules_general_windows>`.
3939
* an :ref:`Amazon module <ansible_collections.amazon.aws.docsite.dev_guide_intro>`.
40-
* an :ref:`oVirt/RHV module <https://github.com/oVirt/ovirt-ansible-collection/blob/master/README-developers.md>`.
40+
* an `oVirt/RHV module <https://github.com/oVirt/ovirt-ansible-collection/blob/master/README-developers.md>`_.
4141
* a :ref:`VMware module <ansible_collections.community.vmware.docsite.vmware_ansible_devguide>`.
4242
* I want to :ref:`write a series of related modules <developing_modules_in_groups>` that integrate Ansible with a new product (for example, a database, cloud provider, network platform, and so on).
4343

docs/docsite/rst/dev_guide/core_index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _developer_guide:
1+
.. _core_developer_guide:
22

33
***************
44
Developer Guide

docs/docsite/rst/dev_guide/developing_modules_general.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ To create a new module in an existing collection called ``my_namespace.my_collec
5050
.. literalinclude:: ../../../../examples/scripts/my_test.py
5151
:language: python
5252

53+
.. _creating_info_facts:
54+
5355
Creating an info or a facts module
5456
==================================
5557

docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ Category "Unable to open shell"
261261

262262
**Platforms:** Any
263263

264-
The ``unable to open shell`` message means that the ``ansible-connection`` daemon has not been able to successfully talk to the remote network device. This generally means that there is an authentication issue. It is a "catch all" message, meaning you need to enable :ref:`logging <a_note_about_logging>` to find the underlying issues.
264+
The ``unable to open shell`` message means that the ``ansible-connection`` daemon has not been able to successfully talk to the remote network device. This generally means that there is an authentication issue. It is a "catch all" message, meaning you need to enable :ref:`logging <enable_network_logging>` to find the underlying issues.
265265

266266

267267

docs/docsite/rst/reference_appendices/logging.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _logging:
2+
13
**********************
24
Logging Ansible output
35
**********************

docs/docsite/rst/reference_appendices/python_3_support.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _ansible_and_python_3:
2+
13
================
24
Python 3 Support
35
================

0 commit comments

Comments
 (0)