documentation_working_group_aka_dawgs
MINUTES

#ansible-docs: Documentation Working Group aka DaWGs

Meeting started by samccann at 15:00:49 UTC (full logs).

Meeting summary

  1. opening chatter (samccann, 15:01:00)
    1. https://github.com/ansible/community/issues/643#issuecomment-1122585506 --> agenda (samccann, 15:02:49)

  2. Documentation updates (samccann, 15:05:54)
    1. - how much if any execution environment mentions do we want in Ansible docs? (samccann, 15:06:05)
    2. ACTION: samcann open issues for adding basic EE info to user and collection dev guides (samccann, 15:13:30)
    3. ACTION: samccann to ask builder team about meta/execution-environment.yml (samccann, 15:15:30)

  3. doctools (samccann, 15:16:37)
    1. https://ansible-builder.readthedocs.io/en/stable/definition/ is the basic one (thedoubl3j, 15:25:26)

  4. splitting doctools into a separate channel (samccann, 15:33:56)
    1. https://github.com/ansible/ansible/pull/77423/ new tests, but has new docs also (bcoca, 15:40:44)
    2. we could split doctools to a separate channel to keep this one docs focused (words on paper) (samccann, 15:44:50)
    3. 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)

  5. sample output for return values (samccann, 15:46:23)
    1. 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)
    2. 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)

  6. Open Floor (samccann, 16:00:13)
    1. 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 (full logs).

Action items

  1. samcann open issues for adding basic EE info to user and collection dev guides
  2. samccann to ask builder team about meta/execution-environment.yml


Action items, by person

  1. samccann
    1. samccann to ask builder team about meta/execution-environment.yml


People present (lines said)

  1. samccann (82)
  2. felixfontein (40)
  3. thedoubl3j (14)
  4. bcoca (11)
  5. zodbot (9)
  6. orandon[m] (5)
  7. briantist (4)
  8. gundalow (1)
  9. Don (0)
  10. Naro (0)


Generated by MeetBot 0.4.