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)
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)
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)