documentation_working_group_aka_dawgs
MINUTES

#ansible-docs: Documentation Working Group aka DaWGs

Meeting started by acozine at 15:31:10 UTC (full logs).

Meeting summary

    1. https://github.com/ansible/ansible/pull/54288/files (acozine, 15:34:41)

  1. finding the Module Dev Tips and Tricks page (acozine, 15:40:37)
    1. https://www.irccloud.com/pastebin/NXZFPcxr/ (acozine, 15:45:05)
    2. AGREED: add developing_modules_best_practices.html to bullet point list and `s/Other Checklists/Checklists` (gundalow, 15:52:57)

  2. ansible-lint and docs examples (acozine, 15:54:49)
    1. ansible -m -a include_tasks task_from_docs.yml --syntax-check localhost doesn't reauire a playbook and may give a better 'correctness' result than just ansible-lint (samccann, 16:06:58)
    2. 12:07 PM <@bcoca> also consider, that many examples use 'assumed vars' that will fail on check as they are not defined - may need an 'exclude undefined errors' exception (samccann, 16:08:36)
    3. ACTION: samccann to experiment with ansible-lint and ansible --syntax-check on adv networking guide task/playbook snippets (samccann, 16:10:18)

  3. openfloor (acozine, 16:10:43)
    1. 12:16 PM <@acozine> and I think the page thing should work with this logic: redirect to <other_version>/path/to/<current_page>.html; if that returns a 404, redirect to index.html (samccann, 16:17:21)
    2. check whether we can place local modification to the Sphinx RTD theme in a persistent `overrides` directory to preserve them when we update the theme (acozine, 16:24:09)
    3. develop list of pages that might be affected by RTD theme upgrades so we can check those with each upgrade (acozine, 16:25:20)

  4. openfloor (acozine, 16:26:13)


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

Action items

  1. samccann to experiment with ansible-lint and ansible --syntax-check on adv networking guide task/playbook snippets


Action items, by person

  1. samccann
    1. samccann to experiment with ansible-lint and ansible --syntax-check on adv networking guide task/playbook snippets


People present (lines said)

  1. acozine (90)
  2. samccann (45)
  3. gundalow (25)
  4. bcoca (23)
  5. zodbot (7)
  6. Xaroth (3)


Generated by MeetBot 0.1.4.