==================================================== #ansible-docs: Documentation Working Group aka DaWGs ==================================================== Meeting started by samccann at 15:00:49 UTC. The full logs are available at https://meetbot.fedoraproject.org/ansible-docs/2022-05-17/documentation_working_group_aka_dawgs.2022-05-17-15.00.log.html . Meeting summary --------------- * opening chatter (samccann, 15:01:00) * LINK: https://github.com/ansible/community/issues/643#issuecomment-1122585506 --> agenda (samccann, 15:02:49) * Documentation updates (samccann, 15:05:54) * - how much if any execution environment mentions do we want in Ansible docs? (samccann, 15:06:05) * ACTION: samcann open issues for adding basic EE info to user and collection dev guides (samccann, 15:13:30) * ACTION: samccann to ask builder team about meta/execution-environment.yml (samccann, 15:15:30) * doctools (samccann, 15:16:37) * LINK: https://ansible-builder.readthedocs.io/en/stable/definition/ is the basic one (thedoubl3j, 15:25:26) * splitting doctools into a separate channel (samccann, 15:33:56) * LINK: https://github.com/ansible/ansible/pull/77423/ new tests, but has new docs also (bcoca, 15:40:44) * we could split doctools to a separate channel to keep this one docs focused (words on paper) (samccann, 15:44:50) * this would help new community writers, but this channel doesn't get a lot of doctools chatter except in meetings so may not be necessary (samccann, 15:45:21) * sample output for return values (samccann, 15:46:23) * can we create a 'sample' output for return values in module docs? Got feedback that a fully-formed example would help people understand it better. (samccann, 15:46:32) * the existing return value samples are per-key and not authored necessarily to be a consistent full example. The result of using this info could produce garbage (samccann, 15:55:10) * Open Floor (samccann, 16:00:13) * LINK: https://github.com/ansible/ansible/pull/77719 <= refactoring, trying to make easier for others to use api to get sidecar info, also fixing some bugs (bcoca, 16:01:47) Meeting ended at 16:04:24 UTC. Action Items ------------ * samcann open issues for adding basic EE info to user and collection dev guides * samccann to ask builder team about meta/execution-environment.yml Action Items, by person ----------------------- * samccann * samccann to ask builder team about meta/execution-environment.yml * **UNASSIGNED** * samcann open issues for adding basic EE info to user and collection dev guides People Present (lines said) --------------------------- * samccann (82) * felixfontein (40) * thedoubl3j (14) * bcoca (11) * zodbot (9) * orandon[m] (5) * briantist (4) * gundalow (1) * Don (0) * Naro (0) Generated by `MeetBot`_ 0.4 .. _`MeetBot`: https://fedoraproject.org/wiki/Zodbot#Meeting_Functions