documentation_working_group_aka_dawgs
MINUTES

#ansible-docs: Documentation Working Group aka DaWGs

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

Meeting summary

  1. opening chatter (samccann, 15:59:31)
    1. new agenda issue for the new year! https://github.com/ansible/community/issues/643 (samccann, 16:04:25)

  2. semantic markup (samccann, 16:04:36)
    1. example - https://ansible.fontein.de/collections/community/dns/hetzner_dns_record_set_module.html#parameters (samccann, 16:05:14)
    2. here's another example with lists and suboptions: https://ansible.fontein.de/collections/community/dns/hetzner_dns_record_sets_module.html#parameters (samccann, 16:07:26)
    3. ACTION: @samccann to push more on the semantic markup review internally and include the example links (samccann, 16:08:03)

  3. documentation work (samccann, 16:12:46)
    1. please help with the docs issue backlog - https://github.com/ansible/ansible/issues?q=is%3Aopen+is%3Aissue+label%3Adocs including some easyfix items https://github.com/ansible/ansible/issues?q=is%3Aopen+is%3Aissue+label%3Adocs+label%3Aeasyfix (samccann, 16:13:25)
    2. comments/approvals of docs PRs from the technical perspective always helps to move them to final merging! - https://github.com/ansible/ansible/pulls?q=is%3Aopen+is%3Apr+label%3Adocs_only (samccann, 16:14:31)
    3. https://github.com/ansible/ansible/issues/75509 (acozine, 16:15:46)
    4. https://docs.ansible.com/ansible/latest/user_guide/intro_getting_started.html (acozine, 16:20:29)
    5. ACTION: acozine to work on creating command cheat-sheet for that issue (samccann, 16:27:30)

  4. Docs tooling (samccann, 16:27:44)
    1. example of the docs workflow in action for a collection-level PR - https://github.com/ansible-collections/community.docker/blob/main/.github/workflows/docs-pr.yml (samccann, 16:31:07)
    2. another example which includes a publish step, and some customization (I commit the output of `antsibull sphinx-init`), it's not much more complicated: https://github.com/ansible-collections/community.hashi_vault/blob/main/.github/workflows/docs.yml (samccann, 16:32:32)
    3. the shared actions and workflows live in the `community.hashi_vault` repo, but they should be moved to their own project(s) so that they can be treated as the separate projects they are (samccann, 16:32:59)
    4. The actions are here: https://github.com/ansible-collections/community.hashi_vault/tree/main/.github/actions/docs (samccann, 16:34:05)
    5. hared workflows are here (they must be mixed with non-shared workflows, so I pre-pended all with `_shared`): https://github.com/ansible-collections/community.hashi_vault/tree/main/.github/workflows (samccann, 16:34:33)

  5. open floor (acozine, 16:55:05)


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

Action items

  1. @samccann to push more on the semantic markup review internally and include the example links
  2. acozine to work on creating command cheat-sheet for that issue


Action items, by person

  1. acozine
    1. acozine to work on creating command cheat-sheet for that issue
  2. samccann
    1. @samccann to push more on the semantic markup review internally and include the example links


People present (lines said)

  1. acozine (63)
  2. samccann (61)
  3. felixfontein (38)
  4. briantist (21)
  5. zodbot (7)
  6. remindbot[m] (4)


Generated by MeetBot 0.4.