#ansible-docs: Documentation Working Group aka DaWGs

Meeting started by samccann at 16:01:01 UTC (full logs).

Meeting summary

  1. Opening Chatter (samccann, 16:01:15)
  2. Action Item review (samccann, 16:04:51)
    1. https://github.com/ansible/community/issues/579#issuecomment-957950690 (samccann, 16:05:16)
    2. core-2.12 docs including japanese translation are all published and done! (samccann, 16:05:37)
    3. expand/collapse - (samccann, 16:08:19)
    4. https://github.com/ansible/ansible/pull/75695/files#diff-418649f5e87f149692d365924e50aeae9f5d28cf2d165c451e3829d107614e81R14 says that sphinx 4.0.2 works fine? (felixfontein, 16:11:38)
    5. ACTION: samccann to confirm expand/collapse PR is correctly setting CI to use sphinx 3 with matt clay (samccann, 16:14:50)
    6. ACTION: samccann ariordan - expermiment with styling of the expand/collapse bar to make it more visually obvious (samccann, 16:20:15)
    7. ACTION: samccann to experiment to see if we can set known-good version of sphinx back to 3.0 (samccann, 16:20:35)
    8. ACTION: samccann to follow up with matt clay and gundalow on how to get sphinx up to 4.x in CI (samccann, 16:25:38)

  3. docs survey issues (samccann, 16:27:12)
    1. we need some help fixing the issues readers told us about in the last survey (samccann, 16:27:27)
    2. https://github.com/ansible/ansible/issues/75508 (samccann, 16:27:59)
    3. https://github.com/ansible/ansible/issues?q=is%3Aopen+is%3Aissue+survey+in%3Atitle (acozine, 16:28:02)
    4. ACTION: acozine to draft some ideas on when to convert playbook to role for #75508 (samccann, 16:29:58)
    5. ACTION: acozine to make a list of all the pages that use hosts: all for issue #75506 (samccann, 16:32:26)

  4. reviving semantic markup (samccann, 16:33:33)
    1. ACTION: samccann to revive Red Hat conversation on semantic markup and impact on ansible-docs and galaxy-ng/AH etc (samccann, 16:36:38)
    2. there's already a PR for antsibull and ansible-doc, so it's mostly things like galaxy-ng/AH, ansible-navigator (in case it formats docs?), and maybe other tools that format docs missing (samccann, 16:38:46)

  5. community-contributed examples (samccann, 16:39:31)
    1. https://github.com/ansible-community/community-topics/issues/39 (samccann, 16:39:34)
    2. ansible-navigator does its own docs construction so also needs to review semantic markup for any potential impacts (samccann, 16:42:21)
    3. ACTION: all - review https://github.com/ansible-community/community-topics/issues/39 for community contributed examples and let's make some progress on this at our next meeting (samccann, 16:43:09)
    4. network/cloud collections also use their own docs generator to render rst files within their collection repos (samccann, 16:44:36)

  6. Open Floor (samccann, 16:50:39)
    1. https://github.com/ansible/ansible/pull/74963 <= planning on taking it up back next week, also planning to document jinja2 filters/tests in core (bcoca, 16:51:40)
    2. sidecar docs pr https://github.com/ansible/ansible/pull/74963 (samccann, 16:53:15)
    3. jinja2 filters/tests docs coming as well (samccann, 16:53:47)
    4. https://paste.debian.net/1218821/ <= ansible-doc -t filter ternary (bcoca, 16:55:37)


Meeting ended at 17:00:00 UTC (full logs).

Action items

  1. samccann to confirm expand/collapse PR is correctly setting CI to use sphinx 3 with matt clay
  2. samccann ariordan - expermiment with styling of the expand/collapse bar to make it more visually obvious
  3. samccann to experiment to see if we can set known-good version of sphinx back to 3.0
  4. samccann to follow up with matt clay and gundalow on how to get sphinx up to 4.x in CI
  5. acozine to draft some ideas on when to convert playbook to role for #75508
  6. acozine to make a list of all the pages that use hosts: all for issue #75506
  7. samccann to revive Red Hat conversation on semantic markup and impact on ansible-docs and galaxy-ng/AH etc
  8. all - review https://github.com/ansible-community/community-topics/issues/39 for community contributed examples and let's make some progress on this at our next meeting


Action items, by person

  1. acozine
    1. acozine to draft some ideas on when to convert playbook to role for #75508
    2. acozine to make a list of all the pages that use hosts: all for issue #75506
  2. ariordan
    1. samccann ariordan - expermiment with styling of the expand/collapse bar to make it more visually obvious
  3. gundalow
    1. samccann to follow up with matt clay and gundalow on how to get sphinx up to 4.x in CI
  4. samccann
    1. samccann to confirm expand/collapse PR is correctly setting CI to use sphinx 3 with matt clay
    2. samccann ariordan - expermiment with styling of the expand/collapse bar to make it more visually obvious
    3. samccann to experiment to see if we can set known-good version of sphinx back to 3.0
    4. samccann to follow up with matt clay and gundalow on how to get sphinx up to 4.x in CI
    5. samccann to revive Red Hat conversation on semantic markup and impact on ansible-docs and galaxy-ng/AH etc


People present (lines said)

  1. samccann (93)
  2. acozine (41)
  3. bcoca (20)
  4. felixfontein (17)
  5. zodbot (10)
  6. ariordan (3)
  7. remindbot[m] (3)
  8. gundalow (1)
  9. briantist (1)


Generated by MeetBot 0.3.