=========================================== #ansible-docs: Docs Working Group aka DaWGs =========================================== Meeting started by acozine at 14:31:34 UTC. The full logs are available at https://meetbot.fedoraproject.org/ansible-docs/2020-05-05/docs_working_group_aka_dawgs.2020-05-05-14.31.log.html . Meeting summary --------------- * checking in about changelogs (acozine, 14:39:53) * LINK: https://github.com/ansible-collections/overview/issues/18 (acozine, 14:39:57) * Ansible-maintained content team considering reno with added work to produce the changelog.yml that felix's work requires. (samccann, 14:41:29) * felixfontein wrote up a spec for the changelog.yaml format (https://github.com/ansible/ansible/blob/devel/packaging/release/changelogs/changelog.py) and added a linter for changelog.yaml files to the generator (samccann, 14:43:28) * felixfontein also prepared a WIP PR to replace ansible's changelog generator with it: https://github.com/ansible/ansible/pull/69313 (samccann, 14:46:38) * LINK: https://github.com/ansible-community/ansibulled (abadger1999, 14:47:16) * docs pipeline update (acozine, 14:53:12) * mock collection to experiment with changelog generator - https://github.com/felixfontein/ansible-versioning_test_collection (samccann, 14:56:00) * LINK: https://www.irccloud.com/pastebin/MVT9chqV/ (samccann, 14:57:55) * updated ACD changelog generator WIP hack: https://github.com/felixfontein/ansibulled/tree/acd-changelog/acd_changelog with result: https://github.com/felixfontein/ansibulled/blob/acd-changelog/acd_changelog/acd.rst (acozine, 14:59:27) * The collection downloading and generation of rst from those collection files will live in ansibulled: https://github.com/ansible-community/ansibulled/pull/5 (samccann, 15:04:13) * The idea is that this will be usable for both the docs pipeline and external collection authors who want to build docs for just their collections. (samccann, 15:04:46) * new collections pipeline will be split into two parts, the ansibulled part mentioned above, which generates rST from plugin docstrings, and the Sphinx (rST-to-HTML) part (acozine, 15:20:36) * collections owners can use ansibulled-docs to generation rST from their plugin docstrings (acozine, 15:21:34) * AGREED: would be good if ansibulled-docs also outputs index.rst files. Will be handy if/when scenario guides are moved into collections /docs folder and pulled back to docs.ansible.com (samccann, 15:24:32) * ansible_metadata (acozine, 15:29:56) * LINK: https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#ansible-metadata-block defines the format (gundalow, 15:32:33) * https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#ansible-metadata-block defines the format (samccann, 15:33:00) * LINK: https://github.com/ansible/ansible/pull/67684 (felixfontein, 15:33:44) * collections meta/routing.yml handles module deprecation in a collection (samccann, 15:36:08) * LINK: https://github.com/ansible/ansible/pull/68646 (samccann, 15:36:54) * supported_by metadata seems to no longer serve a purpose. TBD on whether collection owners/core still want status field in the metadata (stable vs preview etc) (samccann, 15:45:43) * in summary - ansible-base is phasing out ANSIBLE_METADATA entirely, collections 'may' still want to use the status field but we need to followup to see if that's true (samccann, 15:48:22) * collection meta/routing.yml should be the source of truth for deprecation/removed and we can move any other status needs into an optional DOCUMENTATION field (samccann, 15:51:16) * consider ignoring ANSIBLE_METADATA entirely when building collection docs (samccann, 16:05:54) * open floor (acozine, 16:09:38) Meeting ended at 16:13:22 UTC. Action Items ------------ Action Items, by person ----------------------- * **UNASSIGNED** * (none) People Present (lines said) --------------------------- * acozine (132) * abadger1999 (78) * felixfontein (78) * samccann (41) * gundalow (12) * zodbot (11) * bcoca (6) * dmellado (1) * tremble (1) * briantist (1) Generated by `MeetBot`_ 0.1.4 .. _`MeetBot`: http://wiki.debian.org/MeetBot