#ansible-docs: Documentation Working Group aka DaWGs

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

Meeting summary

  1. opening chatter (samccann, 15:00:27)
    1. ACTION: samccann to get ariordan ops rights (samccann, 15:07:06)
    2. still need to followup on CI testing with Sphinx 4 (samccann, 15:11:26)
    3. still need to reword the intro to collection modules so they don't suggest a user has to install the collection (it's already in Ansible) (samccann, 15:12:00)
    4. ACTION: samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text (samccann, 15:14:01)

  2. core-2.12 docs needs (samccann, 15:15:56)
    1. we are tracking 2.12 docs needs with https://github.com/ansible/ansible/issues/75664 (samccann, 15:16:08)
    2. if you see anything missing, please add as a comment to that issue (samccann, 15:16:26)
    3. new module atttributes (samccann, 15:16:48)

  3. New module attributes (samccann, 15:17:07)
    1. background - core supports displaying a batch of 13 or more attributes. See https://github.com/ansible/ansible/issues/75164 for the debate on the docs side (samccann, 15:17:52)
    2. after much deliberation and resorting to a Higher Authority (tm) the decision is to display all the attributes. (samccann, 15:18:13)
    3. we need to determine next if we can do this in a table or if it must be some kind of list. The problem is - each attribute can have 3-6 fields. (samccann, 15:18:47)
    4. https://github.com/ansible/ansible/pull/75619 is the next step on this in core and still in flux. (samccann, 15:19:44)
    5. also, from a usability perspective (mobile apps, etc) - tables are frowned upon (samccann, 15:22:11)
    6. dev_guide/collections_galaxy_meta.rst has an example of how to add a CSS class in rst and also of using an rst list to output an html table (abadger1999, 15:27:50)
    7. ACTION: samccann to mock up the attributes as a list (samccann, 15:29:01)

  4. ssh doc problem (samccann, 15:30:29)
    1. see https://github.com/ansible/ansible/pull/73708 (samccann, 15:30:35)
    2. felixfontein merged a PR which prevents the error message (samccann, 15:33:46)
    3. still needs additional work/PR to add the new info to the output for the ssh plugin (samccann, 15:35:11)

  5. expand/collapse in sphinx (samccann, 15:37:17)
    1. would be nice to have this capability so we can display the new attributes in collapsed state. (samccann, 15:37:47)
    2. see https://github.com/ansible-community/antsibull/pull/303#issuecomment-918345118 (samccann, 15:38:10)
    3. a test PR for this is at https://github.com/ansible/ansible/pull/75695 but has CI problems (samccann, 15:38:50)
    4. https://github.com/ansible/ansible/blob/devel/test/sanity/code-smell/rstcheck.py could be rewritten to use rstcheck as a library, and then one can use the same code as in https://github.com/ansible-community/antsibull/pull/281 to teach it about that directive (felixfontein, 15:42:27)
    5. we can extend irstcheck to ignore the new directives. (samccann, 15:44:11)
    6. ACTION: samccann go read rst check docs for how to do this (samccann, 15:44:48)

  6. Ansible 5 docs needs (samccann, 15:46:23)
  7. Open Floor (samccann, 15:49:19)
    1. https://github.com/ansible-collections/community.hashi_vault/issues/138 (briantist, 15:51:55)


Meeting ended at 16:01:42 UTC (full logs).

Action items

  1. samccann to get ariordan ops rights
  2. samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text
  3. samccann to mock up the attributes as a list
  4. samccann go read rst check docs for how to do this


Action items, by person

  1. ariordan
    1. samccann to get ariordan ops rights
    2. samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text
  2. rights
    1. samccann to get ariordan ops rights
  3. samccann
    1. samccann to get ariordan ops rights
    2. samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text
    3. samccann to mock up the attributes as a list
    4. samccann go read rst check docs for how to do this
  4. the
    1. samccann to mock up the attributes as a list
  5. to
    1. samccann to get ariordan ops rights
    2. samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text
    3. samccann to mock up the attributes as a list
    4. samccann go read rst check docs for how to do this


People present (lines said)

  1. samccann (109)
  2. felixfontein (47)
  3. abadger1999 (20)
  4. gwmngilfen-work (17)
  5. zodbot (13)
  6. acozine (10)
  7. ariordan[m] (9)
  8. briantist (7)
  9. Toshio[m] (3)
  10. ariordan (0)
  11. ok (0)
  12. so (0)
  13. the (0)
  14. only (0)
  15. real (0)
  16. problem (0)
  17. was (0)
  18. I'd (0)
  19. asked (0)
  20. to (0)
  21. handle (0)
  22. chairs (0)
  23. and (0)
  24. she (0)
  25. doesn't (0)
  26. have (0)
  27. correct (0)
  28. rights (0)
  29. yet (0)
  30. right? (0)


Generated by MeetBot 0.3.