docs_working_group_aka_dawgs
MINUTES

#ansible-docs: Docs Working Group aka DaWGs

Meeting started by acozine at 14:31:52 UTC (full logs).

Meeting summary

  1. removing ansible_metadata (acozine, 14:36:11)
    1. collections tracking issue - https://github.com/ansible-collections/overview/issues/57 (samccann, 14:36:42)
    2. ansible-base issue - https://github.com/ansible/ansible/pull/69454 (samccann, 14:36:56)
    3. ansible metdata has two fields, neither of which seem necessary in the new world order (samccann, 14:37:27)
    4. AGREED: move status field to an optional documentation section of each module and remove ANSIBLE_METADATA field entirely (samccann, 14:40:44)
    5. AGREED: create a documentation field for status, default is NULL and will not show up in output (docs or Galaxy/AH). Developer set their preferred default in a doc_fragment (preview or stable). (samccann, 14:54:12)
    6. ACTION: - need to test if a module status setting overrides the doc_fragment setting so an individual module could be preview if the doc_frag default is stable for example (samccann, 14:55:49)
    7. whatever we decide, galaxy, AH, docsite, and ansible-doc will have to change... and likely docs pipeline and doc generation changes too (samccann, 15:02:19)
    8. https://github.com/ansible/proposals/issues/68 (felixfontein, 15:13:45)
    9. ACTION: - samccann to comment on https://github.com/ansible-collections/overview/issues/57 to drop status entirely and ask for feedback on bcoca proposal (samccann, 15:22:13)
    10. https://github.com/ansible/proposals/issues/68 (samccann, 15:22:42)
    11. AGREED: ANSIBLE_METADATA gets dropped entirely, and no immediate replacement for STATUS (samccann, 15:24:23)

  2. version_added (acozine, 15:25:34)
    1. AGREED: for new features in the module docs, `version_added` should refer to the collection version moving forward (acozine, 15:43:48)


Meeting ended at 15:46:38 UTC (full logs).

Action items

  1. - need to test if a module status setting overrides the doc_fragment setting so an individual module could be preview if the doc_frag default is stable for example
  2. - samccann to comment on https://github.com/ansible-collections/overview/issues/57 to drop status entirely and ask for feedback on bcoca proposal


Action items, by person

  1. bcoca
    1. - samccann to comment on https://github.com/ansible-collections/overview/issues/57 to drop status entirely and ask for feedback on bcoca proposal
  2. samccann
    1. - samccann to comment on https://github.com/ansible-collections/overview/issues/57 to drop status entirely and ask for feedback on bcoca proposal


People present (lines said)

  1. acozine (111)
  2. felixfontein (86)
  3. samccann (75)
  4. bcoca (34)
  5. abadger1999 (21)
  6. gundalow (10)
  7. zodbot (8)
  8. cbudz (2)


Generated by MeetBot 0.1.4.