#ansible-docs: Docs Working Group aka DaWGs

Meeting started by acozine at 14:31:24 UTC (full logs).

Meeting summary

  1. opening chatter (acozine, 14:31:47)
  2. slimming down the tarballs by removing docs (acozine, 14:36:02)
    1. Compressed size w/o docs is 28MB vs 29MB today. Installing took 90 sec w/o docs vs 100 sec with (samccann, 14:43:27)
    2. decision was made that it wasn't worth removing docs from the tarballs at this point. (samccann, 14:43:52)

  3. uses of the collection `/docs/` folder (acozine, 14:44:33)
    1. some ideas about the collections /docs folder etc - https://hackmd.io/pPeMLaFYSt2W8RAqm-ZkXA (samccann, 14:48:08)
    2. the goal is to allow collection owners to write 'user guide' and more complex examples etc within the collection /docs folder and then render them in either docs.ansible.com or some future galaxy-ng (samccann, 14:52:48)
    3. we could only include /docs that are explicitly suggested by the collection - e.g. looking ad docs/anstibull.yml file to find rst files to include (samccann, 14:56:39)
    4. ACTION: samccann ask galaxy team what they render today - md/rst and if they look at all in the /docs folder (samccann, 15:02:35)
    5. whateve solution we have for collection /docs needs to cover roles, playbooks, as well as any other guides collectoin owners want to create (samccann, 15:16:06)
    6. ACTION: - we need to get involved in how filter/test docs are structured, how the collection /docs folder works, how roles documenttion will work.. many seats... many tables (samccann, 15:20:15)
    7. would like the collection index to have collection defined: Summary section, auto generated plugin index, links to static content section. (abadger1999, 15:32:13)
    8. we should put collection name and collection version onto the collection index page (regardless of how the rest of the page is structured) (abadger1999, 15:34:27)
    9. see how puppet does some of this https://forge.puppet.com/modules/puppetlabs/stdlib - with tabs for changelogs, example foler from github etc (samccann, 15:34:47)
    10. ACTION: abadger1999 to do a slight mockup of what a new collectoin page could look like (samccann, 15:38:09)

  4. docs user survey (acozine, 15:43:45)
    1. revised user survey draft https://hackmd.io/JemYBo_8QbqqO9cULo3rJQ# (samccann, 15:47:23)
    2. Sections 1 and 2 should tell us how well our documentation is doing (samccann, 15:47:48)
    3. Section 3 lets us "slice and dice" the data by different types of users (samccann, 15:48:11)
    4. feedback deadline is Dec 1 so we can get the survey link into the next Bullhorn (samccann, 15:57:14)

  5. open floor (acozine, 15:57:40)
    1. please provide feedback by Dec 3 on Separating Ansible 3.0.0 collection docs from ansible-core - https://hackmd.io/TQmzyhCUSSKa22iFR_079A?both (samccann, 16:00:50)
    2. No supplementary meeting on Nov. 26, since it's Thanksgiving Day for the US-based docs team (acozine, 16:01:43)


Meeting ended at 16:07:04 UTC (full logs).

Action items

  1. samccann ask galaxy team what they render today - md/rst and if they look at all in the /docs folder
  2. - we need to get involved in how filter/test docs are structured, how the collection /docs folder works, how roles documenttion will work.. many seats... many tables
  3. abadger1999 to do a slight mockup of what a new collectoin page could look like


Action items, by person

  1. abadger1999
    1. abadger1999 to do a slight mockup of what a new collectoin page could look like
  2. samccann
    1. samccann ask galaxy team what they render today - md/rst and if they look at all in the /docs folder


People present (lines said)

  1. acozine (122)
  2. samccann (70)
  3. felixfontein (49)
  4. abadger1999 (36)
  5. dmsimard (15)
  6. baptistemm (12)
  7. zodbot (11)
  8. gwmngilfen (5)
  9. lmodemal (4)
  10. gundalow (2)
  11. aminvakil (1)
  12. cybette (1)


Generated by MeetBot 0.1.4.