Document the possibility of vars/main and defaults/main being directories #1320

radvalach · 2024-04-24T12:48:56Z

This PR dresses the issue #79.
I added an explanation of how these files can be directories with an example. I also mentioned this possibility in relevant places.

…irectories

ansible-documentation-bot · 2024-04-24T12:49:28Z

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.

…ning

oraNod · 2024-04-24T17:13:56Z

@bcoca Would you mind lending your expertise on this one please?

docs/docsite/rst/playbook_guide/playbooks_filters.rst

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst

oraNod · 2024-04-30T14:36:37Z

@radvalach Hi, it looks like this branch has some conflicts. Can you fix them and push again? If you have questions or doubts about resolving conflicts, let us know.

…of custom main files

oraNod

Looks pretty good to me @radvalach I've some suggestions for grammar and style. For the accuracy of the details I'll rely on someone like @bcoca who knows this stuff much better.

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst

samccann

Thanks @radvalach! I read through and added a few thoughts, and in general I agree with bcoca - let's just reference the role structure in most places.

In general, I don't think we need to clarify main.yml vs main.yaml in most places because that's quite common. And the 'main' option is now complicated because within the vars dir etc, it can actually have any name.

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst

docs/docsite/rst/playbook_guide/playbooks_variables.rst

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst

samccann

LGTM!

I can't merge this because of unrelated CI problems, but will as soon as we clear those up. Thanks again for the PR!

patchback · 2024-05-09T19:50:13Z

Backport to stable-2.15: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 34bf3a4 on top of patchback/backports/stable-2.15/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320

Backporting merged PR #1320 into devel

Ensure you have a local repo clone of your fork. Unless you cloned it
from the upstream, this would be your origin remote.
Make sure you have an upstream repo added as a remote too. In these
instructions you'll refer to it by the name upstream. If you don't
have it, here's how you can add it:
```
$ git remote add upstream https://github.com/ansible/ansible-documentation.git
```

Ensure you have the latest copy of upstream and prepare a branch
that will hold the backported code:

$ git fetch upstream
$ git checkout -b patchback/backports/stable-2.15/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320 upstream/stable-2.15

Now, cherry-pick PR Document the possibility of vars/main and defaults/main being directories #1320 contents into that branch:
```
$ git cherry-pick -x 34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb
```
If it'll yell at you with something like fatal: Commit 34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x 34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Document the possibility of vars/main and defaults/main being directories #1320 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/stable-2.15/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320

Create a PR, ensure that the CI is green. If it's not — update it so that
the tests and any other checks pass. This is it!
Now relax and wait for the maintainers to process your pull request
when they have some cycles to do reviews. Don't worry — they'll tell you if
any improvements are necessary when the time comes!

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

patchback · 2024-05-09T19:50:33Z

Backport to stable-2.14: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 34bf3a4 on top of patchback/backports/stable-2.14/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320

Backporting merged PR #1320 into devel

Ensure you have a local repo clone of your fork. Unless you cloned it
from the upstream, this would be your origin remote.
Make sure you have an upstream repo added as a remote too. In these
instructions you'll refer to it by the name upstream. If you don't
have it, here's how you can add it:
```
$ git remote add upstream https://github.com/ansible/ansible-documentation.git
```

Ensure you have the latest copy of upstream and prepare a branch
that will hold the backported code:

$ git fetch upstream
$ git checkout -b patchback/backports/stable-2.14/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320 upstream/stable-2.14

Now, cherry-pick PR Document the possibility of vars/main and defaults/main being directories #1320 contents into that branch:
```
$ git cherry-pick -x 34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb
```
If it'll yell at you with something like fatal: Commit 34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x 34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Document the possibility of vars/main and defaults/main being directories #1320 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/stable-2.14/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320

Create a PR, ensure that the CI is green. If it's not — update it so that
the tests and any other checks pass. This is it!
Now relax and wait for the maintainers to process your pull request
when they have some cycles to do reviews. Don't worry — they'll tell you if
any improvements are necessary when the time comes!

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

samccann · 2024-05-09T19:50:39Z

Thank @radvalach for the Ansible docs fix!

patchback · 2024-05-09T19:50:52Z

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320

Backported as #1443

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

…ries (#1320) * feat: document the possibility of vars/main and defaults/main being directories * fix: add backslashes before "*" symbols to override their special meaning * fix: implement review feedback * fix: change documented possible main file extensions * fix: update feature to accommodate for recently merged documentation of custom main files * fix: move defaults/vars main directories explanation * fix: grammar and style changes * fix: replace "lexicographical" with "alphabetical" * fix: clarify the possibility of specifying custom file name * fix: replace spelling out options with ref to an explanation * fix: fix typo --------- Co-authored-by: Radim Valach <radim.valach@favorlogic.com> (cherry picked from commit 34bf3a4)

patchback · 2024-05-09T19:51:15Z

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/34bf3a4fc521568b3faf65b9926c54c3b5a8a7cb/pr-1320

Backported as #1444

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

…ries (#1320) * feat: document the possibility of vars/main and defaults/main being directories * fix: add backslashes before "*" symbols to override their special meaning * fix: implement review feedback * fix: change documented possible main file extensions * fix: update feature to accommodate for recently merged documentation of custom main files * fix: move defaults/vars main directories explanation * fix: grammar and style changes * fix: replace "lexicographical" with "alphabetical" * fix: clarify the possibility of specifying custom file name * fix: replace spelling out options with ref to an explanation * fix: fix typo --------- Co-authored-by: Radim Valach <radim.valach@favorlogic.com> (cherry picked from commit 34bf3a4)

…ries (#1320) (#1443) * feat: document the possibility of vars/main and defaults/main being directories * fix: add backslashes before "*" symbols to override their special meaning * fix: implement review feedback * fix: change documented possible main file extensions * fix: update feature to accommodate for recently merged documentation of custom main files * fix: move defaults/vars main directories explanation * fix: grammar and style changes * fix: replace "lexicographical" with "alphabetical" * fix: clarify the possibility of specifying custom file name * fix: replace spelling out options with ref to an explanation * fix: fix typo --------- Co-authored-by: Radim Valach <radim.valach@favorlogic.com> (cherry picked from commit 34bf3a4) Co-authored-by: radvalach <134097304+radvalach@users.noreply.github.com>

…ries (#1320) (#1444) * feat: document the possibility of vars/main and defaults/main being directories * fix: add backslashes before "*" symbols to override their special meaning * fix: implement review feedback * fix: change documented possible main file extensions * fix: update feature to accommodate for recently merged documentation of custom main files * fix: move defaults/vars main directories explanation * fix: grammar and style changes * fix: replace "lexicographical" with "alphabetical" * fix: clarify the possibility of specifying custom file name * fix: replace spelling out options with ref to an explanation * fix: fix typo --------- Co-authored-by: Radim Valach <radim.valach@favorlogic.com> (cherry picked from commit 34bf3a4) Co-authored-by: radvalach <134097304+radvalach@users.noreply.github.com>

feat: document the possibility of vars/main and defaults/main being d…

03c7bf6

…irectories

radvalach temporarily deployed to github-bot April 24, 2024 12:49 — with GitHub Actions Inactive

ansible-documentation-bot bot added the new_contributor This PR is the first contribution by a new community member. label Apr 24, 2024

radvalach marked this pull request as draft April 24, 2024 12:51

fix: add backslashes before "*" symbols to override their special mea…

a267c64

…ning

radvalach temporarily deployed to github-bot April 24, 2024 13:00 — with GitHub Actions Inactive

radvalach marked this pull request as ready for review April 24, 2024 13:05

oraNod requested a review from bcoca April 24, 2024 17:10

bcoca reviewed Apr 24, 2024

View reviewed changes

docs/docsite/rst/playbook_guide/playbooks_filters.rst Outdated Show resolved Hide resolved

bcoca reviewed Apr 24, 2024

View reviewed changes

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst Outdated Show resolved Hide resolved

bcoca reviewed Apr 24, 2024

View reviewed changes

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst Outdated Show resolved Hide resolved

fix: implement review feedback

6c6067c

radvalach temporarily deployed to github-bot April 29, 2024 20:14 — with GitHub Actions Inactive

fix: change documented possible main file extensions

74a06c5

radvalach temporarily deployed to github-bot April 29, 2024 20:28 — with GitHub Actions Inactive

radvalach requested a review from bcoca April 30, 2024 09:00

fix: update feature to accommodate for recently merged documentation …

2cb0b06

…of custom main files

radvalach temporarily deployed to github-bot April 30, 2024 18:55 — with GitHub Actions Inactive

fix: move defaults/vars main directories explanation

ed009ed

radvalach temporarily deployed to github-bot April 30, 2024 19:08 — with GitHub Actions Inactive

oraNod reviewed May 1, 2024

View reviewed changes

fix: grammar and style changes

52f2c79

fix: replace "lexicographical" with "alphabetical"

5213d20

radvalach temporarily deployed to github-bot May 1, 2024 15:58 — with GitHub Actions Inactive

radvalach requested a review from bcoca May 1, 2024 15:59

oraNod requested a review from samccann May 2, 2024 10:02

fix: clarify the possibility of specifying custom file name

7f83fcc

radvalach temporarily deployed to github-bot May 6, 2024 09:33 — with GitHub Actions Inactive

samccann reviewed May 6, 2024

View reviewed changes

fix: replace spelling out options with ref to an explanation

c19e877

radvalach had a problem deploying to github-bot May 6, 2024 20:55 — with GitHub Actions Failure

radvalach requested a review from samccann May 6, 2024 20:57

samccann reviewed May 6, 2024

View reviewed changes

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst Outdated Show resolved Hide resolved

fix: fix typo

e1b20cd

radvalach had a problem deploying to github-bot May 6, 2024 21:45 — with GitHub Actions Failure

radvalach requested a review from samccann May 6, 2024 21:46

samccann approved these changes May 7, 2024

View reviewed changes

bcoca approved these changes May 7, 2024

View reviewed changes

radvalach temporarily deployed to github-bot May 8, 2024 21:04 — with GitHub Actions Inactive

samccann merged commit 34bf3a4 into ansible:devel May 9, 2024
8 checks passed

patchback bot mentioned this pull request May 9, 2024

[PR #1320/34bf3a4f backport][stable-2.16] Document the possibility of vars/main and defaults/main being directories #1443

Merged

patchback bot mentioned this pull request May 9, 2024

[PR #1320/34bf3a4f backport][stable-2.17] Document the possibility of vars/main and defaults/main being directories #1444

Merged

akira6592 mentioned this pull request May 13, 2024

Add documentation for defaults/main and vars/main may being a directory #79

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document the possibility of vars/main and defaults/main being directories #1320

Document the possibility of vars/main and defaults/main being directories #1320

radvalach commented Apr 24, 2024

ansible-documentation-bot bot commented Apr 24, 2024

oraNod commented Apr 24, 2024

oraNod commented Apr 30, 2024

oraNod left a comment

samccann left a comment

samccann left a comment

patchback bot commented May 9, 2024 •

edited

Loading

patchback bot commented May 9, 2024 •

edited

Loading

samccann commented May 9, 2024

patchback bot commented May 9, 2024 •

edited

Loading

patchback bot commented May 9, 2024 •

edited

Loading

Document the possibility of vars/main and defaults/main being directories #1320

Document the possibility of vars/main and defaults/main being directories #1320

Conversation

radvalach commented Apr 24, 2024

ansible-documentation-bot bot commented Apr 24, 2024

oraNod commented Apr 24, 2024

oraNod commented Apr 30, 2024

oraNod left a comment

Choose a reason for hiding this comment

samccann left a comment

Choose a reason for hiding this comment

samccann left a comment

Choose a reason for hiding this comment

patchback bot commented May 9, 2024 • edited Loading

Backport to stable-2.15: 💔 cherry-picking failed — conflicts found

Backporting merged PR #1320 into devel

patchback bot commented May 9, 2024 • edited Loading

Backport to stable-2.14: 💔 cherry-picking failed — conflicts found

Backporting merged PR #1320 into devel

samccann commented May 9, 2024

patchback bot commented May 9, 2024 • edited Loading

Backport to stable-2.16: 💚 backport PR created

patchback bot commented May 9, 2024 • edited Loading

Backport to stable-2.17: 💚 backport PR created

patchback bot commented May 9, 2024 •

edited

Loading

patchback bot commented May 9, 2024 •

edited

Loading

patchback bot commented May 9, 2024 •

edited

Loading

patchback bot commented May 9, 2024 •

edited

Loading