version split and supplementary meeting(acozine, 14:40:05)
Thurs supplemental meeting minutes from last
week -
https://github.com/ansible/community/issues/521#issuecomment-721211489(samccann,
14:44:05)
weekly Thurs supplemental meeting starts
10:30am ET on #ansible-docs to cover splitting the docsite(samccann,
14:44:51)
folks are getting confused between ansible-base
and Ansible (the names are too similar) -someone somewhere might
want to consider renaming one of them(samccann,
14:46:14)
removing docs files from Ansible tarballs(acozine, 14:49:15)
need to be careful on naming the docs package
so no one confuses it with `ansible-doc` the cli command(samccann,
14:59:09)
rst were included in main tarball, we used to
have downstream packagers generate htmls and the afformentioned
'ansible-docs' packages(samccann,
15:12:08)
AGREED: we'll build
an `ansible-documentation` package so the documentation is available
to those who want it but the main `ansible` package stays slim; when
the time comes we'll build an `ansible-core-documentation` package
also(acozine,
15:16:21)
first step would be to build the documentation
package, get it published with new releases, and only then kick out
docs from the existing package(felixfontein,
15:19:48)
ACTION: samccann to
followup on docs problems with ansible.utils - hey use something
that is similar to module/plugin docs, but not officially defined by
ansible-base, like
https://github.com/ansible-collections/ansible.utils/blob/main/plugins/test/validate.py(samccann,
15:28:25)
existing filter/test plugins can contain
multiple different plugins in one file .. so the ansible.utils
approach won't help(samccann,
15:29:44)
ACTION: bcoca to post
link to his WIP PR for docs in any plugin type (filters/tests
etc)(samccann,
15:36:32)
roles argspec is wip. see
https://github.com/ansible/ansible/pull/72120 ... might be more
prs(samccann,
15:38:38)
- there are competing needs/wants from a
collection /docs folder.(samccann,
15:50:38)
it would probably help to involve all that are
currently working on docs of some kind - galaxy, ansible.util, roles
argspec, bcoca's branch, antsibull-docs(samccann,
15:52:08)
who/what will consume the files within a
collection /docs folder? AH/galaxy-ng? docs.ansible.com in the
future? ...gasp...access.redhat.com?(samccann,
15:55:00)
- what's the timeline for getting fitler/test
plugins documentable and working with `ansible-doc` and how does
this relate to wha `ansible.utils` is doing in their Dec
release?(samccann,
15:58:18)
what is the timeline for the roles argspec and
does it solve all the roles documentation needs, or will roles also
want manually written docs within a collection /docs folder (and
thus need subfolders which aren't supported today?(samccann,
16:01:22)
can we also support other manual docs, like
scenario guides in the collection /docs folder etc?(samccann,
16:02:19)
samccann to followup on docs problems with ansible.utils - hey use something that is similar to module/plugin docs, but not officially defined by ansible-base, like https://github.com/ansible-collections/ansible.utils/blob/main/plugins/test/validate.py
bcoca to post link to his WIP PR for docs in any plugin type (filters/tests etc)
Action items, by person
bcoca
bcoca to post link to his WIP PR for docs in any plugin type (filters/tests etc)
samccann
samccann to followup on docs problems with ansible.utils - hey use something that is similar to module/plugin docs, but not officially defined by ansible-base, like https://github.com/ansible-collections/ansible.utils/blob/main/plugins/test/validate.py