diff --git a/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst b/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst index 716630f1a0e..b59ebe442ba 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst @@ -12,7 +12,7 @@ Collections MUST follow the `semantic versioning `_ rules. Release planning and announcement ---------------------------------- -#. Announce your intention to release the collection in a corresponding pinned release issue/community pinboard of the collection and in the ``#ansible-community`` `Matrix/IRC channel `_. Repeat the announcement in any other dedicated channels if they exist. +#. Announce your intention to release the collection in a corresponding pinned release issue/community pinboard of the collection and in the ``#ansible-community`` :ref:`Matrix/IRC channel `. Repeat the announcement in any other dedicated channels if they exist. #. Ensure all the other repository maintainers are informed about the time of the following release. @@ -152,7 +152,7 @@ Publishing the collection 5. Announce the release through the `Bullhorn Newsletter `_. -6. Announce the release in the pinned release issue/community pinboard of the collection and in the ``#ansible-community`` `Matrix/Libera.Chat IRC channel `_. +6. Announce the release in the pinned release issue/community pinboard of the collection and in the ``#ansible-community`` :ref:`Matrix/Libera.Chat IRC channel `. 7. In the ``stable-X`` branch, update the version in ``galaxy.yml`` to the next **expected** version, for example, ``X.1.0``. Add, commit and push to the **upstream** repository. @@ -207,7 +207,7 @@ Publishing the collection 4. Announce the release through the `Bullhorn Newsletter `_. -5. Announce the release in the pinned release issue/community pinboard of the collection and in the ``#ansible-community`` `Matrix/IRC channel `_. Additionally, you can announce it using GitHub's Releases system. +5. Announce the release in the pinned release issue/community pinboard of the collection and in the ``#ansible-community`` :ref:`Matrix/IRC channel `. Additionally, you can announce it using GitHub's Releases system. 6. In the ``stable-X`` branch, update the version in ``galaxy.yml`` to the next **expected** version, for example, if you have released ``X.1.0``, the next expected version could be ``X.2.0``. Add, commit and push to the **upstream** repository. @@ -291,7 +291,7 @@ Releasing when more minor versions are expected 4. Announce the release through the `Bullhorn Newsletter `_. -5. Announce the release in the pinned release issue/community pinboard of the collection and in the ``#ansible-community`` `Matrix/IRC channel `. +5. Announce the release in the pinned release issue/community pinboard of the collection and in the ``#ansible-community`` :ref:`Matrix/IRC channel `. Releasing when no more minor versions are expected @@ -338,4 +338,4 @@ Releasing when no more minor versions are expected 4. Announce the release through the `Bullhorn Newsletter `_. -5. Announce the release in the pinned issue/community pinboard of the collection and in the ``#ansible-community`` `Matrix/IRC channel `_. +5. Announce the release in the pinned issue/community pinboard of the collection and in the ``#ansible-community`` :ref:`Matrix/IRC channel `. diff --git a/docs/docsite/rst/community/contributor_path.rst b/docs/docsite/rst/community/contributor_path.rst index 143106558b9..94cda92683e 100644 --- a/docs/docsite/rst/community/contributor_path.rst +++ b/docs/docsite/rst/community/contributor_path.rst @@ -22,7 +22,7 @@ Find the corresponding project These are multiple community projects in the Ansible ecosystem you could contribute to: - `Ansible Core `_ -- `Collections `_ +- :ref:`Collections ` - `AWX `_ - `Galaxy `_ - `ansible-lint `_ diff --git a/docs/docsite/rst/community/steering/steering_committee_membership.rst b/docs/docsite/rst/community/steering/steering_committee_membership.rst index 784baac6593..7405193e930 100644 --- a/docs/docsite/rst/community/steering/steering_committee_membership.rst +++ b/docs/docsite/rst/community/steering/steering_committee_membership.rst @@ -129,7 +129,7 @@ In case of absence or irregular participation, the removal process consists of t Ansible Community Code of Conduct violations ............................................. -In case of the `Ansible Community Code of Conduct `_ violations, the process is the same as above except steps 1-2. Instead: +In case of the :ref:`Ansible Community Code of Conduct ` violations, the process is the same as above except steps 1-2. Instead: #. The initiator reports the case to the Committee by email. diff --git a/docs/docsite/rst/dev_guide/developing_modules_general.rst b/docs/docsite/rst/dev_guide/developing_modules_general.rst index aa85b4f7b7b..a05c1f05b9d 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_general.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_general.rst @@ -180,7 +180,7 @@ information, including instructions for :ref:`testing module documentation `_. + In this case, the tests should be marked with the ``unsupported`` alias in :ref:`aliases file `. Contributing back to Ansible diff --git a/docs/docsite/rst/dev_guide/testing/sanity/import.rst b/docs/docsite/rst/dev_guide/testing/sanity/import.rst index 2f186f1afb1..f7d626cf64d 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/import.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/import.rst @@ -134,6 +134,9 @@ Ansible allows the following unchecked imports from these specific directories: * For ``plugins/modules/`` and ``plugins/module_utils/``, unchecked imports are only allowed from the Python standard library; * For other directories in ``plugins/`` (see `the community collection requirements `_ for a list), unchecked imports are only allowed from the Python standard library, from public dependencies of ansible-core, and from ansible-core itself. +.. Note that the internal link above needs to stay since that page is not part of the ansible-core documentation, + while this document is both part of the ansible-core and the ansible docsite. + Public dependencies of ansible-core are: * Jinja2 diff --git a/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst b/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst index 02c7397847a..590fe556ae2 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst @@ -1,3 +1,5 @@ +.. _integration_aliases: + integration-aliases =================== diff --git a/docs/docsite/rst/dev_guide/testing_integration.rst b/docs/docsite/rst/dev_guide/testing_integration.rst index 85edd61e16b..c438df46708 100644 --- a/docs/docsite/rst/dev_guide/testing_integration.rst +++ b/docs/docsite/rst/dev_guide/testing_integration.rst @@ -18,7 +18,7 @@ Some tests may require root. .. note:: Every new module and plugin should have integration tests, even if the tests cannot be run on Ansible CI infrastructure. - In this case, the tests should be marked with the ``unsupported`` alias in `aliases file `_. + In this case, the tests should be marked with the ``unsupported`` alias in :ref:`aliases file `. Quick Start =========== diff --git a/docs/docsite/rst/inventory_guide/intro_inventory.rst b/docs/docsite/rst/inventory_guide/intro_inventory.rst index 0fb5264e114..0902a54b0c7 100644 --- a/docs/docsite/rst/inventory_guide/intro_inventory.rst +++ b/docs/docsite/rst/inventory_guide/intro_inventory.rst @@ -19,7 +19,7 @@ Ansible :ref:`inventory_plugins` supports a range of formats and sources, which .. contents:: :local: -The following YAML snippets include an ellipsis (...) to indicate that the snippets are part of a larger YAML file. You can find out more about YAML syntax at `YAML Basics `_. +The following YAML snippets include an ellipsis (...) to indicate that the snippets are part of a larger YAML file. You can find out more about YAML syntax at :ref:`yaml_basics`. .. _inventoryformat: diff --git a/docs/docsite/rst/playbook_guide/playbooks_tests.rst b/docs/docsite/rst/playbook_guide/playbooks_tests.rst index 0e15ee98c90..14608a84aac 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_tests.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_tests.rst @@ -195,7 +195,7 @@ In Ansible 2.14, the ``pep440`` option for ``version_type`` was added, and the r "{{ '2.14.0rc1' is version('2.14.0', 'lt', version_type='pep440') }}" -When using ``version`` in a playbook or role, don't use ``{{ }}`` as described in the `FAQ `_ +When using ``version`` in a playbook or role, don't use ``{{ }}`` as described in the :ref:`FAQ `: .. code-block:: yaml diff --git a/docs/docsite/rst/reference_appendices/YAMLSyntax.rst b/docs/docsite/rst/reference_appendices/YAMLSyntax.rst index b445dfe3da1..09a7e2c7d17 100644 --- a/docs/docsite/rst/reference_appendices/YAMLSyntax.rst +++ b/docs/docsite/rst/reference_appendices/YAMLSyntax.rst @@ -15,6 +15,8 @@ You may also wish to read :ref:`working_with_playbooks` at the same time to see is used in practice. +.. _yaml_basics: + YAML Basics ----------- diff --git a/docs/docsite/rst/tips_tricks/ansible_tips_tricks.rst b/docs/docsite/rst/tips_tricks/ansible_tips_tricks.rst index ee4aaf2077d..e18b1e5f816 100644 --- a/docs/docsite/rst/tips_tricks/ansible_tips_tricks.rst +++ b/docs/docsite/rst/tips_tricks/ansible_tips_tricks.rst @@ -66,9 +66,9 @@ Adding a comment (any line starting with ``#``) helps others (and possibly yours Use fully qualified collection names ------------------------------------ -Use `fully qualified collection names (FQCN) `_ to avoid ambiguity in which collection to search for the correct module or plugin for each task. +Use :term:`fully qualified collection names (FQCN) ` to avoid ambiguity in which collection to search for the correct module or plugin for each task. -For `builtin modules and plugins `_, use the ``ansible.builtin`` collection name as a prefix, for example, ``ansible.builtin.copy``. +For :anscollection:`builtin modules and plugins `, use the ``ansible.builtin`` collection name as a prefix, for example, ``ansible.builtin.copy``. .. _inventory_tips: diff --git a/tests/checkers/rstcheck.py b/tests/checkers/rstcheck.py index b20dc6e5746..865aa5b8660 100644 --- a/tests/checkers/rstcheck.py +++ b/tests/checkers/rstcheck.py @@ -19,7 +19,7 @@ def main(): sys.executable, '-c', 'import rstcheck; rstcheck.main();', '--report', 'warning', - '--ignore-roles', 'ansplugin,ansopt,ansretval,ansval,ansenvvar,ansenvvarref', + '--ignore-roles', 'anscollection,ansplugin,ansopt,ansretval,ansval,ansenvvar,ansenvvarref', '--ignore-substitutions', ','.join(ignore_substitutions), ] + paths