#ansible-docs: Docs Working Group aka DaWGs

Meeting summary

1. opening chatter (samccann, 14:31:12)
   
2. introductions (samccann, 14:33:51)
   1. lmodemal joining the Ansible writer team! (samccann, 14:35:29)
   2. Contributor Summit and Ansible Fest is next week Agenda is here https://etherpad.opendev.org/p/virtual-ansible-contributor-summit-october-2020 (gundalow, 14:37:04)
   
   
3. - removing docs rst etc from the ansible tarballs (samccann, 14:38:18)
   1. ansible tarballs are quite big now. We're considering removing the docs rst files and making a separate tarball just for docs for those who may want it locally. could add HTML to it as well? (samccann, 14:43:03)
   2. ACTION: - find out if .rst files within a collection are part of the collection tarballs (and thus making Ansible tarball that much bigger) (samccann, 14:44:42)
   3. yes, seems like the collection tarball does include .rst files. (samccann, 14:45:55)
   4. there are 328 static .rst files in `ansible-base, 967 .rst files in the Ansible 2.10.0 tarball. (samccann, 14:54:29)
   5. let's investigate this a bit further - how much MB saved, % of the size of the existing tarballs etc. And how useful would the folks who want downloadable docs find it as html files in the tarball (samccann, 15:09:41)
   
   
4. Separating `ansible-base` docs from Ansible docs (samccann, 15:10:28)
   1. design choices to make: what docs does a user vs developer of ansible-base need? (abadger1999, 15:13:33)
   2. design choices: what docs should NOT be versioned? (abadger1999, 15:13:51)
   3. redesigns still have to work within the Ansible-2.11 deadline for something presentable (late Jan/early Feb) (abadger1999, 15:15:04)
   4. the Ansible 2.11 deadline is because the url has a version number - so ansible-base would still be 2.10 in the url, but Ansible would be 2.11 for example (samccann, 15:15:41)
   5. some sort of table of personas, products&tools and versions would help us understand how things could be split up (samccann, 15:17:04)
   6. if ansible-base adds some new feature to how inventories work... that is available only to `ansible-base` users and not Ansible users until Ansible releases with it (like 2.10 ansible-base came out first a few months back) (samccann, 15:26:16)
   7. as an analogy - Ansible Automation Platform is MS Office. It has a number of independent bits of software that you get together (word, excell, powerpoint) ansible-base, AH, ... (samccann, 15:30:22)
   8. The MS Office documentation is mostly a top-level link to the relevant individual product docs. Likewise, don't view `ansible` as a first class citizan, more metadata about thing:version that's included (samccann, 15:30:51)
   9. https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux#Kernel_backporting (jtanner, 15:38:22)
   
   
5. generating all module index etc (samccann, 15:40:53)
   1. plugin indexes https://github.com/ansible-community/antsibull/pull/196 - see https://ansible.fontein.de/collections/index_module.html https://ansible.fontein.de/collections/index_lookup.html https://ansible.fontein.de/collections/index_vars.html (samccann, 15:43:22)
   2. - collection version https://github.com/ansible-community/antsibull/pull/200 - see https://ansible.fontein.de/collections/community/crypto/index.html#plugins-in-community-crypto and https://ansible.fontein.de/collections/community/crypto/acme_account_module.html#ansible-collections-community-crypto-acme-account-module (samccann, 15:47:45)
   
   
6. OpenFloor (samccann, 15:50:57)

Action items

1. - find out if .rst files within a collection are part of the collection tarballs (and thus making Ansible tarball that much bigger)

People present (lines said)

1. samccann (114)
2. gundalow (39)
3. abadger1999 (38)
4. felixfontein (24)
5. zodbot (14)
6. cyberpear (10)
7. lmodemal (4)
8. jtanner (3)