#ansible-docs: DaWGs aka Docs Working Group

Meeting started by samccann at 14:31:42 UTC (full logs).

Meeting summary

  1. Fixing edit Github on CLI autogenerated pages (samccann, 14:35:13)
    1. https://github.com/ansible/ansible/pull/63697 (samccann, 14:35:17)
    2. AGREED: - we don't want edits on the cli pages as it's not just changing yaml etc. So remove edit on github from those cli pages (samccann, 14:49:39)
    3. we should allow edits on plugins as they are also embedded docs like module pages (samccann, 14:50:18)
    4. also get edit on github working for other embedded docs such as keywords (samccann, 14:51:03)
    5. https://github.com/ansible/ansible/blob/devel/lib/ansible/cli/adhoc.py#L49 (bcoca, 14:52:03)
    6. https://github.com/ansible/ansible/blob/devel/docs/docsite/keyword_desc.yml <= source for keyword faq (bcoca, 14:56:26)
    7. AGREED: remove edit on Github links for cli pages (samccann, 15:01:44)

  2. linking to Playbook keywords from other examples (samccann, 15:07:07)
    1. https://docs.ansible.com/ansible/devel/reference_appendices/playbooks_keywords.html (samccann, 15:07:47)
    2. https://docs.ansible.com/ansible/latest/user_guide/playbooks_environment.html <= also update this since it doesn't clarify the definition (bcoca, 15:07:51)
    3. https://github.com/ansible/ansible/issues/63947 <= we get this kind of issue all the time (bcoca, 15:09:06)
    4. https://github.com/ansible/ansible/issues/63947 (samccann, 15:10:15)
    5. use issue 63947 for an example of the confusion the environment keyword causes users (samccann, 15:10:37)
    6. https://docs.ansible.com/ansible/latest/user_guide/playbooks_environment.html (samccann, 15:10:51)
    7. playbooks_environment.rst also needs updating as it doesn't clarify the definition (samccann, 15:11:15)

  3. Docs PRs (samccann, 15:13:21)
    1. https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#creating-valid-variable-names (acozine, 15:17:25)
    2. https://github.com/ansible/ansible/pull/64040 (samccann, 15:24:04)

  4. OpenFloor (samccann, 15:29:27)


Meeting ended at 15:33:41 UTC (full logs).

Action items

  1. (none)


People present (lines said)

  1. samccann (76)
  2. bcoca (70)
  3. acozine (52)
  4. falcon78921 (12)
  5. gundalow (10)
  6. zodbot (9)
  7. Xaroth (0)


Generated by MeetBot 0.1.4.