#ansible-docs: Docs Working Group aka DaWGs

Meeting started by acozine at 14:32:02 UTC (full logs).

Meeting summary

    1. add new 'advanced' or 'deep dive' page that describes ansbile's inner workings on how we loop through plays/tasks and what happens at each stage .. mostly that will clarify why undefined in loop is not captured by when and other 'mysteries' (bcoca) (samccann, 14:39:59)

  2. Status Updates (samccann, 14:40:06)
    1. top left search box on devel is now running swiftype search. Feedback most welcome (samccann, 14:41:15)
    2. Added writing guidelines for search optimization (samccann, 14:42:02)
    3. https://docs.ansible.com/ansible/devel/dev_guide/style_guide/search_hints.html (samccann, 14:42:05)

  3. how ansible executes (samccann, 14:45:06)
    1. https://docs.ansible.com/ansible/latest/dev_guide/developing_program_flow_modules.html (samccann, 14:45:24)
    2. above link is a possible home for a deep dive on how ansible executes (samccann, 14:46:07)
    3. https://www.reddit.com/r/ansible/comments/eo6lwq/why_is_ansible_user_not_defined_when_accessed/fe9dcci/ (acozine, 14:46:15)
    4. https://www.reddit.com/r/ansible/comments/eo6lwq/why_is_ansible_user_not_defined_when_accessed/fe9dcci/ - where the request came from (samccann, 14:47:11)
    5. https://www.reddit.com/r/ansible/comments/eo6lwq/why_is_ansible_user_not_defined_when_accessed/ (bcoca, 14:55:08)
    6. consider a user level page to introduce the ansible execution tidbits, then a deeper dive in the dev guide (samccann, 14:55:20)
    7. ACTION: cbudz to draft a topic to cover this (samccann, 14:56:46)

  4. latest user guide updates (acozine, 14:58:07)
    1. http://docs.testing.ansible.com/ansible/devel/user_guide/playbooks_reuse.html (acozine, 15:00:16)
    2. looking for feedback on https://github.com/ansible/ansible/pull/66371 (samccann, 15:02:20)
    3. http://docs.testing.ansible.com/ansible/devel/user_guide/playbooks_reuse_roles.html especially (samccann, 15:02:37)
    4. http://docs.testing.ansible.com/ansible/devel/user_guide/playbooks_tags.html as well (samccann, 15:02:52)

  5. linting examples in the documentation (acozine, 15:06:43)
    1. would be great to run ansible-lint against doc examples in .rst and module docstrings. May require some scripts to do this w/o having to move all examples into separate .yml files (samccann, 15:11:24)
    2. https://github.com/ansible/ansible/issues/58687 - lists top 10 doc pages for Ansible. Good place to start making improvements (samccann, 15:15:00)
    3. https://github.com/ansible/ansible/issues/66474 (zbr, 15:17:58)
    4. https://github.com/ansible/ansible/issues/66474 - new issue to track ansible-lint on docs (samccann, 15:19:23)

  6. open floor (acozine, 15:22:22)
    1. https://github.com/ansible/ansible/pull/66408 (samccann, 15:22:52)


Meeting ended at 15:29:22 UTC (full logs).

Action items

  1. cbudz to draft a topic to cover this


Action items, by person

  1. cbudz
    1. cbudz to draft a topic to cover this


People present (lines said)

  1. acozine (121)
  2. samccann (57)
  3. bcoca (11)
  4. zbr (9)
  5. cbudz_ (8)
  6. zodbot (6)
  7. cbudz (0)


Generated by MeetBot 0.1.4.