Skip to content

Commit

Permalink
Changed all_modules references to list_of_collections in the document…
Browse files Browse the repository at this point in the history
…ation (ansible#71656)
  • Loading branch information
esmersmith authored and heiderich committed Oct 4, 2020
1 parent 3b1e967 commit f5bf36d
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require

:short_description:

* A short description which is displayed on the :ref:`all_modules` page and ``ansible-doc -l``.
* A short description which is displayed on the :ref:`list_of_collections` page and ``ansible-doc -l``.
* The ``short_description`` is displayed by ``ansible-doc -l`` without any category grouping,
so it needs enough detail to explain the module's purpose without the context of the directory structure in which it lives.
* Unlike ``description:``, ``short_description`` should not have a trailing period/full stop.
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/dev_guide/developing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,8 @@ For example vars plugins, see the source code for the `vars plugins included wit

.. seealso::

:ref:`all_modules`
List of all modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`developing_api`
Learn about the Python API for task execution
:ref:`developing_inventory`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,8 @@ This key contains a list of dictionaries that will be presented to the user. Key

.. seealso::

:ref:`all_modules`
Learn about available modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
`GitHub modules directory <https://github.com/ansible/ansible/tree/devel/lib/ansible/modules>`_
Browse source of core and extras modules
`Mailing List <https://groups.google.com/group/ansible-devel>`_
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/reference_appendices/test_strategies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,8 @@ system.

.. seealso::

:ref:`all_modules`
All the documentation for Ansible modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`working_with_playbooks`
An introduction to playbooks
:ref:`playbooks_delegation`
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/scenario_guides/guide_aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,8 @@ documentation for a full list with examples.

.. seealso::

:ref:`all_modules`
All the documentation for Ansible modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`working_with_playbooks`
An introduction to playbooks
:ref:`playbooks_delegation`
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/user_guide/intro_adhoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,8 @@ Now that you understand the basic elements of Ansible execution, you are ready t

:ref:`intro_configuration`
All about the Ansible config file
:ref:`all_modules`
A list of available modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`working_with_playbooks`
Using Ansible for configuration management & deployment
`Mailing List <https://groups.google.com/group/ansible-project>`_
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/user_guide/playbooks_best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,8 @@ This pulls in variables from the group_vars/os_CentOS.yml file.
Learn about YAML syntax
:ref:`working_with_playbooks`
Review the basic playbook features
:ref:`all_modules`
Learn about available modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`developing_modules`
Learn how to extend Ansible by writing your own modules
:ref:`intro_patterns`
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/user_guide/playbooks_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ The `ansible-lint default rules <https://docs.ansible.com/ansible-lint/rules/def
Learn about YAML syntax
:ref:`playbooks_best_practices`
Tips for managing playbooks in the real world
:ref:`all_modules`
Learn about available modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`developing_modules`
Learn to extend Ansible by writing your own modules
:ref:`intro_patterns`
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/user_guide/playbooks_reuse_includes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ The content on this page has been moved to :ref:`playbooks_reuse`.
Conditionals in playbooks
:ref:`playbooks_loops`
Loops in playbooks
:ref:`all_modules`
Learn about available modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`developing_modules`
Learn how to extend Ansible by writing your own modules
`GitHub Ansible examples <https://github.com/ansible/ansible-examples>`_
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/user_guide/playbooks_reuse_roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,8 @@ Read the `Ansible Galaxy documentation <https://galaxy.ansible.com/docs/>`_ page
Loops in playbooks
:ref:`tags`
Using tags to select or skip roles/tasks in long playbooks
:ref:`all_modules`
List of available modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`developing_modules`
Extending Ansible by writing your own modules
`GitHub Ansible examples <https://github.com/ansible/ansible-examples>`_
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/user_guide/sample_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,8 @@ in the directory structure example at the start of this section.
Learn about YAML syntax
:ref:`working_with_playbooks`
Review the basic playbook features
:ref:`all_modules`
Learn about available modules
:ref:`list_of_collections`
Browse existing collections, modules, and plugins
:ref:`developing_modules`
Learn how to extend Ansible by writing your own modules
:ref:`intro_patterns`
Expand Down

0 comments on commit f5bf36d

Please sign in to comment.