search

StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
73 stars 20 forks source link

Update examples in section 3.4.5.2 Ansible courses (?) #598

Closed rclee33 closed 3 months ago

rclee33 commented 3 months ago

Under "Boolean" in the WUG, the convention is to use true and false to set Boolean values in YAML files.

However, in section 3.4.5.2 Ansible Courses, there are several examples showing yes and no. Are those examples out of alignment with the guidance in the WUG? Or, perhaps we need to clarify between Ansible Booleans in a playbook, and a setting in a configuration file (which might use yes).

daobrien commented 3 months ago

I think the idea there is that you can use either in playbooks, and this is just recognizing that fact. @bonnevil might have more up-to-date info on preferences.

rclee33 commented 3 months ago

@bonnevil opened a PR to address this issue: https://github.com/StyleGuides/WritingStyleGuide/pull/600

rclee33 commented 3 months ago

PR600 is merged, so closing this issue.