#ansible-docs: DAWGs aka Ansible Documentation working group

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

Meeting summary

  1. opening chatter (samccann, 15:01:35)
  2. Action item review (samccann, 15:05:00)
    1. PR to patch 2.9/2.10 to work with sphinx 4 - https://github.com/ansible/ansible/pull/75288 (samccann, 15:08:56)
    2. required_if does not need more info (samccann, 15:11:42)
    3. required_if does not need descriptive test. We can construct a standard documentation sentence from what we have to give the argspec (samccann, 15:12:42)
    4. roles documentation from the argspec pr - https://github.com/ansible-community/antsibull/pull/272 (samccann, 15:14:57)
    5. on https://github.com/ansible/ansible/pull/75288 - dmsimar talking with fedora to see what the status is (samccann, 15:18:11)
    6. ACTION: samccann and acozine - review roles docs PR one last time - https://github.com/ansible-community/antsibull/pull/272 to approve (samccann, 15:19:41)

  3. mutually_exclusive added to docs string (samccann, 15:20:52)
    1. https://github.com/ansible/ansible/pull/74873#issuecomment-880850893 (samccann, 15:21:08)
    2. if we include this item, it needs a sanity check to make sure if the info is in the DOCUMENTATION, it matches the info in the argspec as well (samccann, 15:24:07)

  4. - rendering collection-level docs (samccann, 15:27:21)
    1. https://github.com/ansible/community/issues/579#issuecomment-883649348 (samccann, 15:27:38)
    2. - today's problem - a collection contributor has no way to verify any docs changes work until after merging and AFTER uploading to galaxy. (samccann, 15:29:41)
    3. and waiting until devel docs pull in that update to docs.ansible.com/ansible/devel. And that only works for collections already in Ansible. (samccann, 15:30:31)
    4. the solution should allow for these contributors to generate the html, have :refs: that work, and not require deep sphinx/rst knowledge (samccann, 15:31:16)
    5. we could extend `antsibull-docs to create a functioning docsite (document a collection and links work to ansible docsite). (samccann, 15:38:24)
    6. we'd need to document how to set up and invoke this locally (samccann, 15:38:45)
    7. https://gist.github.com/felixfontein/6de36fff529a12b0c4ffd4aa73a82b6d (when run in an empty directory) will build a small docsite for community.docker and community.crypto (felixfontein, 15:40:00)
    8. https://gist.github.com/felixfontein/6de36fff529a12b0c4ffd4aa73a82b6d (when run in an empty directory) will build a small docsite for community.docker and community.crypto (samccann, 15:40:35)
    9. maybe two commands: antsibull-docs init and then the antsibull-docs collection command you already have (samccann, 15:43:25)
    10. the proposed `antsibull init` command could create an example script that runs out of the box or the user can modify as they want. (samccann, 15:49:27)
    11. antsibull-build should not get too involved in knowing things that other tools should do (sphinx-build options, setting up rsync, etc). But it's okay if those are in the script with sane defaults and the user can tweak them to meet their needs (samccann, 15:51:29)
    12. ACTION: felixfontein to work on creating the script associated with `antsibull` to allow locally generated docsite for collection-level docs (samccann, 15:52:13)

  5. openfloor (samccann, 15:54:06)
    1. validate-modules PR https://github.com/ansible/ansible/pull/74873 can also impact all the other users of DOCUMENTATION block, including galaxy-ng etc (samccann, 16:00:27)


Meeting ended at 16:02:21 UTC (full logs).

Action items

  1. samccann and acozine - review roles docs PR one last time - https://github.com/ansible-community/antsibull/pull/272 to approve
  2. felixfontein to work on creating the script associated with `antsibull` to allow locally generated docsite for collection-level docs


Action items, by person

  1. felixfontein
    1. felixfontein to work on creating the script associated with `antsibull` to allow locally generated docsite for collection-level docs
  2. samccann
    1. samccann and acozine - review roles docs PR one last time - https://github.com/ansible-community/antsibull/pull/272 to approve


People present (lines said)

  1. samccann (104)
  2. felixfontein (33)
  3. abadger1999 (19)
  4. briantist (16)
  5. zodbot (12)
  6. lmodemal (7)
  7. dmsimard (2)
  8. tadeboro (2)
  9. dericcrago (1)
  10. gundalow (0)


Generated by MeetBot 0.1.4.