#ansible-docs: Documentation Working Group aka DaWGs
Meeting started by samccann at 15:59:25 UTC
(full logs).
Meeting summary
- opening chatter (samccann, 15:59:31)
- new agenda issue for the new year!
https://github.com/ansible/community/issues/643 (samccann,
16:04:25)
- semantic markup (samccann, 16:04:36)
- example -
https://ansible.fontein.de/collections/community/dns/hetzner_dns_record_set_module.html#parameters
(samccann,
16:05:14)
- 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)
- ACTION: @samccann to
push more on the semantic markup review internally and include the
example links (samccann,
16:08:03)
- documentation work (samccann, 16:12:46)
- 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)
- 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)
- https://github.com/ansible/ansible/issues/75509
(acozine,
16:15:46)
- https://docs.ansible.com/ansible/latest/user_guide/intro_getting_started.html
(acozine,
16:20:29)
- ACTION: acozine to
work on creating command cheat-sheet for that issue (samccann,
16:27:30)
- Docs tooling (samccann, 16:27:44)
- 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)
- 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)
- 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)
- The actions are here:
https://github.com/ansible-collections/community.hashi_vault/tree/main/.github/actions/docs
(samccann,
16:34:05)
- 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)
- open floor (acozine, 16:55:05)
Meeting ended at 17:00:47 UTC
(full logs).
Action items
- @samccann to push more on the semantic markup review internally and include the example links
- acozine to work on creating command cheat-sheet for that issue
Action items, by person
- acozine
- acozine to work on creating command cheat-sheet for that issue
- samccann
- @samccann to push more on the semantic markup review internally and include the example links
People present (lines said)
- acozine (63)
- samccann (61)
- felixfontein (38)
- briantist (21)
- zodbot (7)
- remindbot[m] (4)
Generated by MeetBot 0.4.