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.

Sign up for GitHub

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

Jump to bottom

Muni tech writers: Ansible include_task search documentation incorrect #357 #1321

Merged
merged 9 commits into from May 22, 2024
Merged

Muni tech writers: Ansible include_task search documentation incorrect #357 #1321

merged 9 commits into from May 22, 2024

Conversation

vojtam
Copy link
Contributor

@vojtam vojtam commented Apr 24, 2024

Hi, this (draft) PR concerns the issue #357 and addresses the comments made to the previous PR #1263
I have made the changes suggested and requested in the comments, and I hope that this one is in better shape.

mainly, I pulled the information about the distinction between the contexts that are used for lookups under a single note to (hopefully) make it compliant with the comment #1263 (comment)

@vojtam
Reworked headings
4effdab 
  * better subsection heading about how plugins resolve local relative paths
  * put information about troubleshooting search paths into sub-subsection
@vojtam
replaced single backticks with double ones in places where syntax sho…
4c596ea 
…uld be highlighted
@vojtam
Refactored the line about ansible not searching the current workdir.
fdc65aa
@vojtam
Added a note describing how Ansible deals with relative tasks paths w…
85e80a6 
…hen using include_role vs when using include_taks / import_task
@vojtam vojtam marked this pull request as draft April 24, 2024 14:33
@oraNod oraNod added 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 backport-2.16 Automatically create a backport for the stable-2.16 branch MUNI tech writers backport-2.17 Automatically create a backport for the stable-2.17 branch labels Apr 24, 2024
@vojtam
fix: tiny stylistic changes
4797331
@vojtam
moved Troubleshooting search paths subsection to the bottom of the pa…
cf2b859 
…ge and moved the note with details about current work dir up, where it fits better
@oraNod oraNod requested a review from samccann May 2, 2024 10:01
@oraNod oraNod marked this pull request as ready for review May 14, 2024 16:25
@oraNod
Copy link
Contributor

oraNod commented May 14, 2024

@vojtam Hi, I've pushed a commit to your branch.

@bcoca Could you please take another look and let us know if you have any final nits? Thanks!

@oraNod oraNod requested a review from bcoca May 14, 2024 17:30
samccann
samccann approved these changes May 16, 2024
View reviewed changes
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

Just a tiny nit.

docs/docsite/rst/playbook_guide/playbook_pathing.rst Outdated Show resolved Hide resolved
@oraNod @samccann
Update docs/docsite/rst/playbook_guide/playbook_pathing.rst
9f8a128 
Co-authored-by: Sandra McCann <samccann@redhat.com>
@oraNod
Copy link
Contributor

oraNod commented May 17, 2024

@bcoca Aloha. Thanks for all the reviews so far on this one. Hopefully we've got it all sorted now. If you could take one last look and approve, we'd appreciate it. Cheers.

@oraNod oraNod merged commit c216a1a into ansible:devel May 22, 2024
8 checks passed
@patchback Patchback
Copy link

patchback bot commented May 22, 2024 •
edited

Backport to stable-2.15: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.15/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

Backported as #1511

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

@oraNod
Copy link
Contributor

oraNod commented May 22, 2024

Thanks very much for the docs contribution @vojtam 🎉

patchback bot pushed a commit that referenced this pull request May 22, 2024
@oraNod @patchback
Merge pull request #1321 from vojtam/feature/#357
1389eb1 
Muni tech writers: Ansible include_task search documentation incorrect #357

(cherry picked from commit c216a1a)
@patchback patchback bot mentioned this pull request May 22, 2024
Merged
@patchback Patchback
Copy link

patchback bot commented May 22, 2024 •
edited

Backport to stable-2.14: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.14/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

Backported as #1512

🤖 @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 May 22, 2024
@oraNod @patchback
Merge pull request #1321 from vojtam/feature/#357
444e81a 
Muni tech writers: Ansible include_task search documentation incorrect #357

(cherry picked from commit c216a1a)
@patchback patchback bot mentioned this pull request May 22, 2024
Merged
@patchback Patchback
Copy link

patchback bot commented May 22, 2024 •
edited

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

Backported as #1513

🤖 @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 May 22, 2024
@oraNod @patchback
Merge pull request #1321 from vojtam/feature/#357
c50f2d5 
Muni tech writers: Ansible include_task search documentation incorrect #357

(cherry picked from commit c216a1a)
@patchback patchback bot mentioned this pull request May 22, 2024
Merged
@patchback Patchback
Copy link

patchback bot commented May 22, 2024 •
edited

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

Backported as #1514

🤖 @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 May 22, 2024
@oraNod @patchback
Merge pull request #1321 from vojtam/feature/#357
eaeb415 
Muni tech writers: Ansible include_task search documentation incorrect #357

(cherry picked from commit c216a1a)
@patchback patchback bot mentioned this pull request May 22, 2024
Merged
oraNod added a commit that referenced this pull request May 22, 2024
@oraNod
Merge pull request #1512 from ansible/patchback/backports/stable-2.14…
a9b35f1 
…/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

[PR #1321/c216a1a9 backport][stable-2.14] Muni tech writers: Ansible include_task search documentation incorrect #357
oraNod added a commit that referenced this pull request May 22, 2024
@oraNod
Merge pull request #1511 from ansible/patchback/backports/stable-2.15…
aeeed58 
…/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

[PR #1321/c216a1a9 backport][stable-2.15] Muni tech writers: Ansible include_task search documentation incorrect #357
oraNod added a commit that referenced this pull request May 22, 2024
@oraNod
Merge pull request #1513 from ansible/patchback/backports/stable-2.16…
7cb1c5f 
…/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

[PR #1321/c216a1a9 backport][stable-2.16] Muni tech writers: Ansible include_task search documentation incorrect #357
oraNod added a commit that referenced this pull request May 22, 2024
@oraNod
Merge pull request #1514 from ansible/patchback/backports/stable-2.17…
3c14712 
…/c216a1a9e874dbf0698ef8634089be6040379dec/pr-1321

[PR #1321/c216a1a9 backport][stable-2.17] Muni tech writers: Ansible include_task search documentation incorrect #357
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bcoca bcoca bcoca approved these changes

@samccann samccann samccann approved these changes

@oraNod oraNod oraNod approved these changes

@felixfontein felixfontein Awaiting requested review from felixfontein

Assignees
No one assigned
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
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@vojtam @oraNod @bcoca @samccann