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

Encourage true/false for module documentation #80060

Merged
merged 2 commits into from
Mar 2, 2023

Conversation

kristianheljas
Copy link
Contributor

SUMMARY

Make ansible-lint happy and conform to the community decision.

CC @samccann

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@ansibot
Copy link
Contributor

ansibot commented Feb 21, 2023

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.

click here for bot help

@ansibot ansibot added affects_2.15 docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory docsite This issue/PR relates to the documentation website. needs_triage Needs a first human triage before being processed. small_patch labels Feb 21, 2023
@mattclay mattclay removed the needs_triage Needs a first human triage before being processed. label Feb 23, 2023
Copy link
Contributor

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

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

Some general improvements for that bullet point, that aren't specific to this change. (The change itself looks good!)

@samccann samccann merged commit 02c49ff into ansible:devel Mar 2, 2023
@samccann
Copy link
Contributor

samccann commented Mar 2, 2023

Thanks @kristianheljas for the fix and @felixfontein for the review!

samccann pushed a commit to samccann/ansible that referenced this pull request Mar 2, 2023
Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 02c49ff)
@samccann samccann mentioned this pull request Mar 2, 2023
nitzmahone pushed a commit that referenced this pull request Mar 3, 2023
* Add Steampunk Spotter to Other tools list (#80006)

(cherry picked from commit 122de95)

* Clarify combine filter examples (#80078)

(cherry picked from commit 39fd899)

* Add Ansible community 7.3.0 porting guide (#80106)

(cherry picked from commit dbcaab1)

* Clarify when plugin settings are being populated (#79710)

(cherry picked from commit 998b5c1)

* Update playbooks_tests.rst (#79788)

(cherry picked from commit ed87995)

* consistent booleans for page text and code blocks (#80036)

* consistent booleans for page text and code blocks

* Update check_mode from n to false

(cherry picked from commit 940fdf5)

* Update collection_integration_updating.rst (#80037)

(cherry picked from commit ce5471f)

* package_facts requires python-rpm on SUSE systems in ansible 2.12.1 (#80041)

(cherry picked from commit 43aa47c)

* fix: jinja complex type transforms doesn't work as documented (#80067)

jinja complex type transforms: dict(somelist| slice(2)) doesn't work as documented. Changed the example to use zip_longest

(cherry picked from commit 5ad77fc)

* Docs: Clarify note on tags (#80079)

The current wording could be read as "tasks that are tagged *both* configuration and packages" while in fact it is "tasks that are tagged *either* configuration *or* packages"

(cherry picked from commit 563833d)

* Fix typo docs in playbooks_tags.rst (#80117)

(cherry picked from commit c8f740c)

* Encourage true/false for module documentation (#80060)

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 02c49ff)

* fix link for development guidelines (#80055)

(cherry picked from commit 012393e)

* improve password lookup syntax in examples (#80092)

(cherry picked from commit 809727a)

* Fixing typos (#80045)

(cherry picked from commit 841b71c)

* clarify  playbook tests (#80073)

(cherry picked from commit 0521184)

* Update playbooks_conditionals.rst (#80062)

"changed" was missing from the docs

(cherry picked from commit cc8e6d0)

---------

Co-authored-by: Anže Luzar <[email protected]>
Co-authored-by: Klaus Frank <[email protected]>
Co-authored-by: Anwesha Das <[email protected]>
Co-authored-by: nkakouros <[email protected]>
Co-authored-by: Gijikiki <[email protected]>
Co-authored-by: Aastha Varma <[email protected]>
Co-authored-by: Player256 <[email protected]>
Co-authored-by: Desmond Obisi <[email protected]>
Co-authored-by: Raphael Michel <[email protected]>
Co-authored-by: Nicolas P <[email protected]>
Co-authored-by: Kristian Heljas <[email protected]>
Co-authored-by: Akira Yokochi <[email protected]>
Co-authored-by: Andreas Deininger <[email protected]>
Co-authored-by: Keeper-of-the-Keys <[email protected]>
@ansible ansible locked and limited conversation to collaborators Mar 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.15 docs_only All changes are to files within the docs/docsite/ directory docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. has_issue small_patch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants