Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide #1283

Merged
merged 2 commits into from
Apr 25, 2024

Conversation

Devids10
Copy link
Contributor

@Devids10 Devids10 commented Apr 18, 2024

This branch fixes the confusion in the example module group name in the issue #1070. Special thanks to @evgeni for the new clear example.

@ansible-documentation-bot ansible-documentation-bot bot added the new_contributor This PR is the first contribution by a new community member. label Apr 18, 2024
@ansible-documentation-bot
Copy link
Contributor

Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

@Devids10 Devids10 changed the title Clarify example module group name in the playbook guide MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide Apr 18, 2024
@@ -154,22 +154,24 @@ In a playbook, you can set module defaults for whole groups of modules, such as

In ansible-core 2.12, collections can define their own groups in the ``meta/runtime.yml`` file. ``module_defaults`` does not take the ``collections`` keyword into account, so the fully qualified group name must be used for new groups in ``module_defaults``.

Here is an example ``runtime.yml`` file for a collection and a sample playbook using the group.
Here is an example ``runtime.yml`` file for the ``ns.coll`` collection defining an action group ``ns.coll.my_group`` and placing the ``sample_module`` from ``ns.coll`` and ``another_module`` from ``another.collection`` into it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Here is an example ``runtime.yml`` file for the ``ns.coll`` collection defining an action group ``ns.coll.my_group`` and placing the ``sample_module`` from ``ns.coll`` and ``another_module`` from ``another.collection`` into it.
Here is an example ``runtime.yml`` file for the ``ns.coll`` collection.
This file defines an action group named ``ns.coll.my_group`` and places the ``sample_module`` from ``ns.coll`` and ``another_module`` from ``another.collection`` into the group.

@oraNod oraNod added backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.14 Automatically create a backport for the stable-2.14 branch labels Apr 18, 2024
Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @Devids10

@oraNod oraNod merged commit 87886f1 into ansible:devel Apr 25, 2024
8 checks passed
Copy link

patchback bot commented Apr 25, 2024

Backport to stable-2.15: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.15/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

Backported as #1336

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Apr 25, 2024
MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide

(cherry picked from commit 87886f1)
Copy link

patchback bot commented Apr 25, 2024

Backport to stable-2.14: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.14/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

Backported as #1337

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Apr 25, 2024
MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide

(cherry picked from commit 87886f1)
Copy link

patchback bot commented Apr 25, 2024

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

Backported as #1338

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Apr 25, 2024
MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide

(cherry picked from commit 87886f1)
Copy link

patchback bot commented Apr 25, 2024

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

Backported as #1339

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Apr 25, 2024
MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide

(cherry picked from commit 87886f1)
oraNod added a commit that referenced this pull request Apr 25, 2024
…/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

[PR #1283/87886f18 backport][stable-2.17] MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide
oraNod added a commit that referenced this pull request Apr 25, 2024
…/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

[PR #1283/87886f18 backport][stable-2.16] MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide
oraNod added a commit that referenced this pull request Apr 25, 2024
…/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

[PR #1283/87886f18 backport][stable-2.14] MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide
oraNod added a commit that referenced this pull request Apr 25, 2024
…/87886f18ee012b103c0bb831bf8aeaa7db591dce/pr-1283

[PR #1283/87886f18 backport][stable-2.15] MUNI_TECH_WRITERS: Clarify example module group name in the playbook guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.14 Automatically create a backport for the stable-2.14 branch backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch MUNI tech writers new_contributor This PR is the first contribution by a new community member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants