#ansible-docs: Documentation Working Group aka DaWGs

Meeting started by samccann at 15:00:57 UTC (full logs).

Meeting summary

  1. Action Item updates: (samccann, 15:06:11)
    1. open - Create tracking issue 'somewhere' to track all the collections that SHOULD consider using true/false boolean in examples (tho some may not want to for $REASONS) (samccann, 15:06:24)
    2. resolved - merged antsibull-docs update to docs requirements. Will need to schedule remaining requirements updates for later this Autumn (samccann, 15:07:15)
    3. resolved - collection owners fixed a few broken docs links in their Galaxy docsite links etc (samccann, 15:08:04)

  2. Hacktoberfest (samccann, 15:14:37)
    1. we hope to participate in Hactoberfest by creating a batch of easy-fix issues to help us clean up the docs. See https://hacktoberfest.com/participation/ for what this is (samccann, 15:15:11)
    2. initial brainstorming ideas of what we could fix - https://hackmd.io/gNQ2TQW8T4ilcZc8JAM5fQ (samccann, 15:16:29)
    3. ACTION: samccann to ask community team if someone has rights to add hacktoberfest topic to all collections (esp new ones as this was done last year for existing collections) (samccann, 15:22:59)
    4. should also consider some repos won't want to participate in hacktoberfest as it does trigger some 'spam' PRs. (samccann, 15:23:49)

  3. Documentation updates (samccann, 15:28:42)
    1. https://github.com/ansible-collections/community.hashi_vault/pull/299 (briantist, 15:30:18)
    2. https://docs.ansible.com/ansible/devel/collections/community/hashi_vault/index.html#changelog (briantist, 15:30:18)
    3. ACTION: samccann to open issue(s) to suggest collection owners link in their changelogs (such as https://github.com/ansible-collections/community.hashi_vault/pull/299) (samccann, 15:30:54)
    4. IF we have more markup languages for docs in other projects, they must have a reasonable display on github (samccann, 15:34:04)
    5. any markup has to also display well on docs.ansible.com as a priority (samccann, 15:34:28)
    6. one option - we could recommend RST for ansible projects, but allow MD if it already exists, etc. (samccann, 15:44:11)

  4. Open Floor (samccann, 15:47:21)
    1. generally leaning toward 'recommending RST but allowing MD (samccann, 15:50:22)
    2. ACTION: samccann to consider an 'open docs hr' later in the week to regularly interact with docs contributors in a friendlier way than the expert details that happen in DaWGs meetings (samccann, 15:56:18)
    3. consider it as a possible optional separate DaWGs meeting (samccann, 15:57:19)
    4. ACTION: samccann -t to add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare. (samccann, 15:58:34)


Meeting ended at 16:00:28 UTC (full logs).

Action items

  1. samccann to ask community team if someone has rights to add hacktoberfest topic to all collections (esp new ones as this was done last year for existing collections)
  2. samccann to open issue(s) to suggest collection owners link in their changelogs (such as https://github.com/ansible-collections/community.hashi_vault/pull/299)
  3. samccann to consider an 'open docs hr' later in the week to regularly interact with docs contributors in a friendlier way than the expert details that happen in DaWGs meetings
  4. samccann -t to add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.


Action items, by person

  1. samccann
    1. samccann to ask community team if someone has rights to add hacktoberfest topic to all collections (esp new ones as this was done last year for existing collections)
    2. samccann to open issue(s) to suggest collection owners link in their changelogs (such as https://github.com/ansible-collections/community.hashi_vault/pull/299)
    3. samccann to consider an 'open docs hr' later in the week to regularly interact with docs contributors in a friendlier way than the expert details that happen in DaWGs meetings
    4. samccann -t to add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.


People present (lines said)

  1. samccann (95)
  2. acozine (30)
  3. briantist (15)
  4. zodbot (10)
  5. felixfontein (3)
  6. DonNaro[m] (2)
  7. Dhee5096[m] (1)
  8. Don (0)
  9. Naro (0)
  10. Dhee#5096 (0)


Generated by MeetBot 0.4.