#ansible-docs: Documentation Working Group aka DaWGs

Meeting summary

1. opening chatter (samccann, 15:00:55)
   
2. introductions (samccann, 15:04:13)
   1. today we have a new RH writer coming in to help us in DaWgs land - ariordan[m]. (samccann, 15:04:59)
   
   
3. action item review (samccann, 15:08:11)
   1. - samccann didn't get to any of her action items yet so they remain on the list this week (samccann, 15:09:40)
   
   
4. search improvements (samccann, 15:10:50)
   1. details on attributes - https://hackmd.io/R71WLQjPQOa-Ze0Cg97V7A and PR - Attributes compat ansible#75563 (samccann, 15:16:05)
   2. next steps - (1) Need to mock up what we want the collection docs pages that display collections look like (probably a plugin page and a list of all attributes) (samccann, 15:20:02)
   3. (2) Need to get changes made to the attributes so that we can only display attributes which differ from their default setting on the plugin page itself. (samccann, 15:20:12)
   4. If (2) can't be done in time, then maybe we need to revert changes to the plugin docs in ansible-core which removed the documentation which is duplicated by the attributes. (samccann, 15:22:06)
   5. ACTION: samccann ariordan[m] work with abadger1999 to create dummy plugin rst pages to see what attributes might look like (samccann, 15:24:27)
   
   
5. - things breaking the docs build (samccann, 15:26:39)
   1. https://github.com/ansible/ansible/pull/73708 (abadger1999, 15:27:54)
   2. command line arguments being added to the config subsystem which reads out of documentation https://github.com/ansible/ansible/pull/73708 (samccann, 15:28:31)
   3. https://github.com/ansible/ansible/pull/74963 (abadger1999, 15:29:44)
   4. https://github.com/ansible/ansible/pull/74873 (abadger1999, 15:29:56)
   5. docs in side car https://github.com/ansible/ansible/pull/74963 (samccann, 15:30:11)
   6. adding mutually_exclusive, required_if, and other arg spec modifiers https://github.com/ansible/ansible/pull/74873 (samccann, 15:30:29)
   7. semantic markup (approved by docs, but not other impacted teams like core, galaxy-ah etc) - ansible-core portion: https://github.com/ansible/ansible/pull/74937 antsibull portion: https://github.com/ansible-community/antsibull/pull/281 (samccann, 15:31:11)
   8. command line args breaks the ssh connection plugin, might need to be reverted (or fixed) . Followup with nitzmahone (samccann, 15:34:00)
   9. ACTION: samccann to create a master list of these priority items impacting the docs to raise visibility on what needs to happen with only 2.5 weeks till core freeze (samccann, 15:34:45)
   
   
6. Things we need done for 2.12 (samccann, 15:41:16)
   1. gwmngilfen-work has more time to polish up matrix docs (samccann, 15:44:23)
   
   
7. rendering docs in collections at the PR level (samccann, 15:48:47)
   1. briantist has a way to render docs from a collection PR (samccann, 15:49:56)
   2. show diff output in an expandable box in the PR comment. Demo PR (reviews on content welcome too!): https://github.com/ansible-collections/community.hashi_vault/pull/139 (samccann, 15:50:11)
   3. documenting some of the existing functionality and details in an issue (it'll find a better home later). A lot of this is dedicated to explaining the somewhat confusing, tricky, and potentially dangerous `pull_request_target` event needed in GitHub actions: https://github.com/ansible-collections/community.hashi_vault/issues/138 (samccann, 15:50:26)
   
   
8. Open Floor (samccann, 15:53:01)
   1. remind bot can give little reminders, for example !remind in 1 min; test (samccann, 15:55:41)
   2. to cancel a reminder !cancelreminder !remind test (samccann, 15:57:55)
   3. to list reminders !listreminders (samccann, 15:58:11)

Action items

1. samccann ariordan[m] work with abadger1999 to create dummy plugin rst pages to see what attributes might look like
2. samccann to create a master list of these priority items impacting the docs to raise visibility on what needs to happen with only 2.5 weeks till core freeze

Action items, by person

1. abadger1999
   1. samccann ariordan[m] work with abadger1999 to create dummy plugin rst pages to see what attributes might look like
2. ariordan[m]
   1. samccann ariordan[m] work with abadger1999 to create dummy plugin rst pages to see what attributes might look like
3. samccann
   1. samccann ariordan[m] work with abadger1999 to create dummy plugin rst pages to see what attributes might look like
   2. samccann to create a master list of these priority items impacting the docs to raise visibility on what needs to happen with only 2.5 weeks till core freeze

People present (lines said)

1. samccann (97)
2. gwmngilfen-work (35)
3. abadger1999 (34)
4. briantist (14)
5. zodbot (11)
6. ariordan[m] (5)
7. gundalow (2)
8. dericcrago (1)
9. remindbot[m] (1)