dawgs_(documentation_working_group)
MINUTES

#ansible-docs: DAWGS (Documentation Working Group)

Meeting started by samccann at 14:34:23 UTC (full logs).

Meeting summary

  1. Status Updates (samccann, 14:37:52)
    1. left hand search is now using swiftype search on 'latest' (samccann, 14:38:44)
    2. User Guide PR merged!! Improved the flow of sections of the Ansible User Guide (samccann, 14:39:56)
    3. continued work coming on other sections of the User Guide (samccann, 14:40:57)
    4. work coming on updating collections doc and creating ansible_user doc (samccann, 14:41:37)
    5. based on this: https://www.reddit.com/r/ansible/comments/eo6lwq/why_is_ansible_user_not_defined_when_accessed/ (samccann, 14:42:32)

  2. Search box on docs.ansible.com (samccann, 14:44:01)
    1. https://www.reddit.com/r/ansible/comments/eu4jat/mindblowing_docsansiblecom_does_not_have_a_search/ (samccann, 14:46:04)
    2. each docsite (ansible, galaxy, tower) has its own search but nothing on the top page allows for a cross-site search) (samccann, 14:51:53)
    3. docs.ansible.com is also a confusing page with a lot of content. needs to be simplified/redesigned (samccann, 14:52:20)
    4. on duckduckgo, you can type !ansible loops and get search results from docs.ansible.com only (samccann, 14:56:42)
    5. on duckduckgo, you can also use !galaxy or !ansiblemod yum to get directly to the yum module docs page for example (samccann, 14:57:15)

  3. View vs Edit Github links (samccann, 14:59:24)
    1. would be nice if a reader has the option to click view on github instead of always edit on gitub (samccann, 14:59:47)
    2. if you aren't logged into github, the Edit on Github link takes you to the login page, not the content you wanted to edit. So you have to be logged in to even view the page (samccann, 15:03:36)
    3. possibly this is useful for module pages, where a developer wants to quickly scan the code but not edit it. (samccann, 15:06:07)

  4. Putting module names in changelog fragments (samccann, 15:07:52)
    1. some changelog fragments talk about adding a parameter etc, but don't actually name the module it applies to (samccann, 15:08:18)
    2. AGREED: update the changelog guidelines to ensure it says included all relevant info including module names etc (samccann, 15:12:05)
    3. AGREED: find a way to spread this need to those who merge module changes etc (samccann, 15:12:36)

  5. Open Floor (samccann, 15:14:34)
    1. for Edit vs View on Github - an example would be finding a doc change and wanting to find the code change that matched it. So view the file on github, find the commit/pr, and find what code changed underneath. (samccann, 15:20:49)

  6. Docs Issues and PRs (samccann, 15:27:28)
    1. we have 225 open Docs issues and 102 open docs PRS (samccann, 15:30:23)


Meeting ended at 15:30:56 UTC (full logs).

Action items

  1. (none)


People present (lines said)

  1. samccann (91)
  2. acozine (50)
  3. cbudz (14)
  4. cyberpear (11)
  5. zodbot (7)


Generated by MeetBot 0.1.4.