From 7a24541d18f9d145cc0146de47b735d99eaa818f Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Thu, 4 Aug 2022 16:48:41 -0400 Subject: [PATCH] Backportapalooza 08 04 (#78450) * fix broken link (#78434) (cherry picked from commit eb46ab1399ae30c217d2ba3032cc505d12fef354) * Fix escaped asterisk in code block demonstrating wildcards (#78375) The code block is rendered verbatim. This currently results in `\*` being shown, which is incorrect (i.e., not parsed as a wildcard pattern). Removing the superfluous `\` fixes the rendering. This PR fixes all instances of this issue on that page. (cherry picked from commit 9bf5da8f75398584ebb54306454e9cc385ccc4f4) * add example to import a playbook from collection (#78443) (cherry picked from commit eb462edb1690cd18dbd5dad48688c0525506ab9f) * docs: Fix control node reference links (#78424) (cherry picked from commit f5cac6bc5d6dcf8a6acc1b32e8b77452b7be646f) * Update galaxy_server_list (#78398) (cherry picked from commit d92f6da592283482e373c519d12afabe954b31f4) * Improve grammar (#78391) (cherry picked from commit ddd8b8bfd9e392d2c1ad643bbe2884f931ff6a79) Co-authored-by: Tom Janson Co-authored-by: Sebastian Gumprich Co-authored-by: Ian Wienand Co-authored-by: Tabah Baridule Co-authored-by: Geoffrey van Wyk --- docs/docsite/rst/community/contributor_path.rst | 2 +- docs/docsite/rst/dev_guide/developing_python_3.rst | 4 ++-- docs/docsite/rst/shared_snippets/basic_concepts.txt | 12 ++++++------ .../rst/shared_snippets/galaxy_server_list.txt | 3 +-- docs/docsite/rst/user_guide/intro_patterns.rst | 6 +++--- lib/ansible/modules/import_playbook.py | 3 +++ 6 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/docsite/rst/community/contributor_path.rst b/docs/docsite/rst/community/contributor_path.rst index 699038177b2..aced42b31d8 100644 --- a/docs/docsite/rst/community/contributor_path.rst +++ b/docs/docsite/rst/community/contributor_path.rst @@ -95,7 +95,7 @@ Become a steering committee member You do NOT have to be a programmer to become a steering committee member. -The `Steering Committee `_ member status reflects the highest level of trust which allows contributors to lead the project through making very important `decisions `_ for the Ansible project. The Committee members are the community leaders who shape the project's future and the future of automation in the IT world in general. +The :ref:`Steering Committee ` member status reflects the highest level of trust which allows contributors to lead the project through making very important `decisions `_ for the Ansible project. The Committee members are the community leaders who shape the project's future and the future of automation in the IT world in general. To reach the status, as the current Committee members did before getting it, along with the things mentioned in this document, you should: diff --git a/docs/docsite/rst/dev_guide/developing_python_3.rst b/docs/docsite/rst/dev_guide/developing_python_3.rst index 43221b0342e..ecc2106a6b3 100644 --- a/docs/docsite/rst/dev_guide/developing_python_3.rst +++ b/docs/docsite/rst/dev_guide/developing_python_3.rst @@ -4,7 +4,7 @@ Ansible and Python 3 ******************** -The ``ansible-core`` code runs Python 3 (for specific versions check `Control Node Requirements <:ref:control-node-requirements>`_. +The ``ansible-core`` code runs Python 3 (for specific versions check :ref:`Control Node Requirements ` Contributors to ``ansible-core`` and to Ansible Collections should be aware of the tips in this document so that they can write code that will run on the same versions of Python as the rest of Ansible. @@ -25,7 +25,7 @@ However, the three types of code do not use the same string strategy. If you're Minimum version of Python 3.x and Python 2.x ============================================ -See `Control Node Requirements <:ref:control-node-requirements>`_ and `Managed Node Requirements <:ref:managed-node-requirements>`_ for the +See :ref:`Control Node Requirements ` and `Managed Node Requirements <:ref:managed-node-requirements>`_ for the specific versions supported. Your custom modules can support any version of Python (or other languages) you want, but the above are the requirements for the code contributed to the Ansible project. diff --git a/docs/docsite/rst/shared_snippets/basic_concepts.txt b/docs/docsite/rst/shared_snippets/basic_concepts.txt index d4154f6eaab..f2648cbf6a9 100644 --- a/docs/docsite/rst/shared_snippets/basic_concepts.txt +++ b/docs/docsite/rst/shared_snippets/basic_concepts.txt @@ -20,7 +20,7 @@ To learn more about inventory, see :ref:`the Working with Inventory`_. To learn more about collections, see :ref:`collections`. Collection resources can be used independently and discretely from each other. +A format in which Ansible content is distributed that can contain playbooks, roles, modules, and plugins. You can install and use collections through `Ansible Galaxy `_. To learn more about collections, see :ref:`collections`. Collection resources can be used independently and discretely from each other. AAP diff --git a/docs/docsite/rst/shared_snippets/galaxy_server_list.txt b/docs/docsite/rst/shared_snippets/galaxy_server_list.txt index be54f1f045d..9991d85899a 100644 --- a/docs/docsite/rst/shared_snippets/galaxy_server_list.txt +++ b/docs/docsite/rst/shared_snippets/galaxy_server_list.txt @@ -75,5 +75,4 @@ For operations that use only one Galaxy server (for example, the ``publish``, `` ``server_list``, unless you pass in an explicit server with the ``--server`` argument. .. note:: - Once a collection is found, any of its requirements are only searched within the same Galaxy instance as the parent - collection. The install process will not search for a collection requirement in a different Galaxy instance. + ``ansible-galaxy`` can seek out dependencies on other configured Galaxy instances to support the use case where a collection can depend on a collection from another Galaxy instance. diff --git a/docs/docsite/rst/user_guide/intro_patterns.rst b/docs/docsite/rst/user_guide/intro_patterns.rst index 3d0686da504..f4c209912bb 100644 --- a/docs/docsite/rst/user_guide/intro_patterns.rst +++ b/docs/docsite/rst/user_guide/intro_patterns.rst @@ -82,9 +82,9 @@ You can use wildcard patterns with FQDNs or IP addresses, as long as the hosts a .. code-block:: yaml - 192.0.\* - \*.example.com - \*.com + 192.0.* + *.example.com + *.com You can mix wildcard patterns and groups at the same time: diff --git a/lib/ansible/modules/import_playbook.py b/lib/ansible/modules/import_playbook.py index 27c93a0311c..9adaebf363f 100644 --- a/lib/ansible/modules/import_playbook.py +++ b/lib/ansible/modules/import_playbook.py @@ -59,6 +59,9 @@ EXAMPLES = r''' vars: service: httpd +- name: Include a playbook from a collection + ansible.builtin.import_playbook: my_namespace.my_collection.my_playbook + - name: This DOES NOT WORK hosts: all tasks: