dawgs_aka_docs_working_group
14.31
October 01, 2019
ansible-docs
#ansible-docs: DaWGs aka Docs Working Group
Meeting started by samccann at 14:31:26 UTC
(full logs ).
Meeting summary
Filter page docs discussion (samccann , 14:33:53)
https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html
(samccann ,
14:34:09)
filter docs page is too long, bad SEO
experience since cannot search on an individual filter, and lacks
examples (samccann ,
14:40:30)
we could model the filters after the plugins -
have a 'main page' that explains in general and then link to each
with specific docs/examples (samccann ,
14:41:29)
https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters_ipaddr.html
(samccann ,
14:45:50)
https://github.com/ansible/ansible/pull/46979
(bcoca ,
14:50:24)
wip pr adding more examples - #link
https://github.com/ansible/ansible/pull/46979 (samccann ,
14:51:22)
'tests' have a similar problem to the filters
page (samccann ,
14:56:28)
https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/index.html#all-sanity-tests
(acozine ,
14:58:18)
AGREED : - consider
breaking up the filters page into high level groupings with more
examples for each filter type (samccann ,
14:58:34)
https://docs.ansible.com/ansible/latest/user_guide/playbooks_tests.html
(bcoca ,
14:59:05)
https://docs.ansible.com/ansible/latest/user_guide/playbooks_tests.html
for jinja2 tests (samccann ,
14:59:30)
support elements in return values in documentation (samccann , 15:08:29)
https://github.com/ansible/ansible/pull/62929
for sample PR (samccann ,
15:09:01)
AGREED : worth adding
support for elements in return value docs (samccann ,
15:23:07)
open floor (acozine , 15:24:18)
Meeting ended at 15:31:23 UTC
(full logs ).
Action items
(none)
People present (lines said)
acozine (81)
samccann (50)
bcoca (25)
cyberpear (22)
felixfontein (9)
zodbot (8)
Generated by MeetBot 0.1.4.