diff --git a/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst b/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst index eb77f26e721..548b55261a5 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst @@ -32,7 +32,7 @@ By default Ansible will look in each directory within a role for a ``main.yml`` - ``vars/main.yml`` - other variables for the role (see :ref:`playbooks_variables` for more information). - ``files/main.yml`` - files that the role deploys. - ``templates/main.yml`` - templates that the role deploys. -- ``meta/main.yml`` - metadata for the role, including role dependencies. +- ``meta/main.yml`` - metadata for the role, including role dependencies and optional Galaxy metadata such as platforms supported. You can add other YAML files in some directories. For example, you can place platform-specific tasks in separate files and refer to them in the ``tasks/main.yml`` file: @@ -579,9 +579,9 @@ Sharing roles: Ansible Galaxy `Ansible Galaxy `_ is a free site for finding, downloading, rating, and reviewing all kinds of community-developed Ansible roles and can be a great way to get a jumpstart on your automation projects. -The client ``ansible-galaxy`` is included in Ansible. The Galaxy client allows you to download roles from Ansible Galaxy, and also provides an excellent default framework for creating your own roles. +The client ``ansible-galaxy`` is included in Ansible. The Galaxy client allows you to download roles from Ansible Galaxy and provides an excellent default framework for creating your own roles. -Read the `Ansible Galaxy documentation `_ page for more information +Read the `Ansible Galaxy documentation `_ page for more information. A page that refers back to this one frequently is the Galaxy Roles document which explains the required metadata your role needs for use in Galaxy . .. seealso:: diff --git a/docs/docsite/rst/user_guide/playbooks_reuse_roles.rst b/docs/docsite/rst/user_guide/playbooks_reuse_roles.rst index d49deb5014f..31d1ad0aa3d 100644 --- a/docs/docsite/rst/user_guide/playbooks_reuse_roles.rst +++ b/docs/docsite/rst/user_guide/playbooks_reuse_roles.rst @@ -4,4 +4,4 @@ Roles ***** -This page has moved to :ref:`playbooks_reuse_roles`. \ No newline at end of file +This page has moved to :ref:`playbooks_reuse_roles`. diff --git a/docs/docsite/rst/user_guide/shared_snippets/role_directory.txt b/docs/docsite/rst/user_guide/shared_snippets/role_directory.txt index 5722f0ee894..25aa1784b19 100644 --- a/docs/docsite/rst/user_guide/shared_snippets/role_directory.txt +++ b/docs/docsite/rst/user_guide/shared_snippets/role_directory.txt @@ -16,7 +16,7 @@ defaults/ # main.yml # <-- default lower priority variables for this role meta/ # - main.yml # <-- role dependencies + main.yml # <-- role dependencies and optional Galaxy info library/ # roles can also include custom modules module_utils/ # roles can also include custom module_utils lookup_plugins/ # or other types of plugins, like lookup in this case