-
Notifications
You must be signed in to change notification settings - Fork 752
Improve failed_when documentation and fix minor errors #3249
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
Conversation
- Add clarifying example for 'or' operator in failed_when conditions - Fix template syntax: remove extra space in Jinja2 braces Signed-off-by: Piyush Malik <[email protected]>
|
Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the |
Co-authored-by: Felix Fontein <[email protected]>
|
Thanks for the review! I’ve applied your suggested change. Let me know if anything else is needed. |
oraNod
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution @malikdotexe
Backport to stable-2.18: 💔 cherry-picking failed — conflicts found❌ Failed to cleanly apply 7cefbd2 on top of patchback/backports/stable-2.18/7cefbd2a0c80ae0d5b3e7fee2d114ed43f9c05b0/pr-3249 Backporting merged PR #3249 into devel
🤖 @patchback |
Backport to stable-2.19: 💚 backport PR created✅ Backport PR branch: Backported as #3332 🤖 @patchback |
* Improve failed_when documentation and fix minor errors - Add clarifying example for 'or' operator in failed_when conditions - Fix template syntax: remove extra space in Jinja2 braces Signed-off-by: Piyush Malik <[email protected]> * Update docs/docsite/rst/playbook_guide/playbooks_error_handling.rst Co-authored-by: Felix Fontein <[email protected]> --------- Signed-off-by: Piyush Malik <[email protected]> Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 7cefbd2)
Backport to stable-2.20: 💚 backport PR created✅ Backport PR branch: Backported as #3333 🤖 @patchback |
* Improve failed_when documentation and fix minor errors - Add clarifying example for 'or' operator in failed_when conditions - Fix template syntax: remove extra space in Jinja2 braces Signed-off-by: Piyush Malik <[email protected]> * Update docs/docsite/rst/playbook_guide/playbooks_error_handling.rst Co-authored-by: Felix Fontein <[email protected]> --------- Signed-off-by: Piyush Malik <[email protected]> Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 7cefbd2)
* Improve failed_when documentation and fix minor errors - Add clarifying example for 'or' operator in failed_when conditions - Fix template syntax: remove extra space in Jinja2 braces * Update docs/docsite/rst/playbook_guide/playbooks_error_handling.rst --------- (cherry picked from commit 7cefbd2) Signed-off-by: Piyush Malik <[email protected]> Co-authored-by: Piyush Malik <[email protected]> Co-authored-by: Felix Fontein <[email protected]>
* Improve failed_when documentation and fix minor errors - Add clarifying example for 'or' operator in failed_when conditions - Fix template syntax: remove extra space in Jinja2 braces * Update docs/docsite/rst/playbook_guide/playbooks_error_handling.rst --------- (cherry picked from commit 7cefbd2) Signed-off-by: Piyush Malik <[email protected]> Co-authored-by: Piyush Malik <[email protected]> Co-authored-by: Felix Fontein <[email protected]>
SUMMARY
Improve the Ansible error handling documentation by clarifying failed_when conditions and fixing minor syntax errors.
ISSUE TYPE
COMPONENT NAME
playbook_guide/playbooks_error_handling.rst
ANSIBLE VERSION
N/A
ADDITIONAL INFORMATION
This PR makes three key improvements to the error handling documentation:
Enhanced failed_when explanation: Added a practical example showing how to use the
oroperator in failed_when conditions, making it clearer that users can trigger failure when ANY condition is met (not just all conditions).Template syntax fix: Corrected malformed Jinja2 braces by removing extra space in
{{ log_path }}{{ log_file }}.These changes improve readability and correctness of the documentation without changing any functionality.