You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docsite/rst/community/collection_contributors/collection_requirements.rst
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,7 @@ The following guidelines describe the required infrastructure for your collectio
105
105
Python Compatibility
106
106
====================
107
107
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`.
109
109
110
110
.. _coll_python_reqs:
111
111
@@ -227,19 +227,19 @@ Other directories
227
227
.. _coll_docs_structure_reqs:
228
228
229
229
Documentation requirements
230
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
230
+
~~~~~~~~~~~~~~~~~~~~~~~~~~
231
231
232
232
Collections:
233
233
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>`.
235
235
* ``SHOULD`` have contributor guidelines in the ``CONTRIBUTING.md`` or ``README.md`` file.
236
236
237
237
All modules and plugins:
238
238
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).
241
241
* ``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.
243
243
* ``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.
244
244
245
245
* You do not have to add ``version_added`` when creating a new collection before its first release.
@@ -326,7 +326,7 @@ Module naming
326
326
* Modules that only gather and return information MUST be named ``<something>_info``.
327
327
* Modules that gather and return ``ansible_facts`` MUST be named ``<something>_facts`` and MUST NOT return anything but facts.
328
328
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>`.
330
330
331
331
.. _coll_licensing_req:
332
332
@@ -427,8 +427,8 @@ To receive important announcements that can affect the collections (for example,
427
427
428
428
* Collections MUST run an equivalent of the ``ansible-test sanity --docker`` command.
429
429
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.
432
432
433
433
* You SHOULD *additionally* run ``ansible-test sanity`` from the ansible/ansible ``devel`` branch so that you find out about new linting requirements earlier.
434
434
* The sanity tests MUST pass.
@@ -493,10 +493,10 @@ Development conventions
493
493
All modules in your collection:
494
494
495
495
* 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.
497
497
* 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>`).
Copy file name to clipboardExpand all lines: docs/docsite/rst/community/maintainers_guidelines.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ See the :ref:`Communication guide <communication_irc>` to learn more about real-
70
70
Community Topics
71
71
----------------
72
72
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.
74
74
75
75
Share your opinion and vote on the topics to help the community make the best decisions.
Copy file name to clipboardExpand all lines: docs/docsite/rst/dev_guide/ansible_index.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ Find the task that best describes what you want to do:
37
37
* a :ref:`network module <developing_modules_network>`
38
38
* a :ref:`Windows module <developing_modules_general_windows>`.
39
39
* 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>`_.
41
41
* a :ref:`VMware module <ansible_collections.community.vmware.docsite.vmware_ansible_devguide>`.
42
42
* 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).
Copy file name to clipboardExpand all lines: docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -261,7 +261,7 @@ Category "Unable to open shell"
261
261
262
262
**Platforms:** Any
263
263
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.
0 commit comments