14:31:13 <acozine> #startmeeting Docs Working Group aka DaWGs
14:31:13 <zodbot> Meeting started Tue Jan 21 14:31:13 2020 UTC.
14:31:13 <zodbot> This meeting is logged and archived in a public location.
14:31:13 <zodbot> The chair is acozine. Information about MeetBot at http://wiki.debian.org/MeetBot.
14:31:13 <zodbot> Useful Commands: #action #agreed #halp #info #idea #link #topic.
14:31:13 <zodbot> The meeting name has been set to 'docs_working_group_aka_dawgs'
14:31:20 <acozine> who's around?
14:31:27 <cbudz_> :hand raised:
14:31:30 * gundalow waves, though in another meeting
14:31:37 * samccann also lurking
14:31:46 <acozine> #chair cbudz
14:31:46 <zodbot> Current chairs: acozine cbudz
14:32:25 <acozine> gundalow samccann I won't make you chairs for the meeting
14:32:43 <acozine> but thanks for keeping one eye on the meeting
14:33:54 <acozine> anybody else?
14:34:57 <bcoca> all hands + other meeting ... so you have 20% of me
14:35:22 <acozine> bcoca: gotcha, I won't make you a chair then either
14:36:14 <acozine> Agenda: https://github.com/ansible/community/issues/389#issuecomment-574230629
14:36:22 <acozine> it's pretty sparse
14:37:35 <acozine> status updates from the team
14:37:55 <samccann> #topic Status Updates
14:38:07 <acozine> Mine is: still working on the User Guide revamp - slow but steady will get through it eventually
14:38:23 <acozine> also, back to working on the Collections Docs pipeline
14:38:27 <samccann> #info User Guide revamp still ongoing
14:38:42 <samccann> #info minor heading changes to Install Guide to help search results (fingers crossed)
14:39:10 <acozine> our goal is to have Collections docs for stuff that moves out of core by the middle of March
14:39:17 <acozine> earlier if we can manage it
14:39:30 <samccann> #nfo continuing work on the Collections Docs pipeline (bringing module docs from inside collections into docs.ansible.com. Goal is to have somethign working by middle of March
14:39:35 <samccann> dag nammit!
14:39:56 <samccann> #info continuing work on the Collections Docs pipeline (bringing module docs from inside collections into docs.ansible.com. Goal is to have somethign working by middle of March
14:40:03 <acozine> heh
14:40:15 <samccann> and still mispelled somthing
14:40:17 <acozine> typos are always with us
14:40:19 <samccann> TWICE!
14:40:47 <cbudz_> it's only Tuesday, all is forgiven
14:40:50 <bcoca> i am contagious
14:41:02 <acozine> PR for latest User Guide changes if anyone has time/bandwidth to review: https://github.com/ansible/ansible/pull/66371
14:41:29 <acozine> heh, Tuesday and yesterday was kind of a holiday - at least, samccann and I were both out doing the Day of Service
14:42:25 <cbudz_> left some comments on that PR:overall I think its very successful in the goals of reorganizing
14:43:30 <acozine> oh, thanks for hte review cbudz_!
14:43:55 <acozine> my browser view had gone stale, so I hadn't seen your comments before
14:44:29 <cbudz_> no problem, it was a nice change of gears yesterday.
14:45:01 <acozine> looks like I have some work queued up for this afternoon :-)
14:45:22 <samccann> ok my other meeting ended so here for realz now
14:45:35 <acozine> #chair samccann
14:45:35 <zodbot> Current chairs: acozine cbudz samccann
14:45:43 <samccann> #info PR for latest User Guide changes if anyone has time/bandwidth to review: https://github.com/ansible/ansible/pull/66371
14:45:47 <bcoca> 1 down 2 to go .. but another all hands comming up
14:45:56 <samccann> too many hands for you bcoca
14:46:04 <bcoca> you sound like my X
14:46:05 <cbudz_> All Hands Tuesday
14:46:24 * bcoca hides from HR
14:46:34 * samccann does NOT ask for clarification on bcoca's comment... does NOT ASK
14:46:58 <acozine> heh
14:47:27 <bcoca> kidding aside, skimmed user guide, looks really good
14:47:40 <acozine> bcoca: thanks
14:47:42 <bcoca> need to give it in depth read but new layout is good
14:48:07 <acozine> fewer pages is better in my opinion, unless they get too long
14:48:38 <bcoca> agreed, also the divisions makre more sense now .. a lot of the previous was 'people stacking on top when they didnt know where to put it'
14:49:11 <samccann> since I'm in a search mood, I'll just add the tidbit that search results always point to the top of a page (even if what you searched for was a heading at the end).  just fyi
14:49:33 <acozine> yeah, it's tough to keep docs clean when you add new documentation and new functionality piece by piece
14:49:43 <acozine> it piles up a bit
14:50:09 <bcoca> its good to have more docs, bad to  have them in such a way you cannot find what you need
14:50:12 <acozine> samccann: w00t!
14:51:24 <acozine> `clear, concise, consistent, compelling, credible`
14:51:45 <acozine> good docs are all of ^^^
14:52:19 <acozine> samccann: for next week, can you check the site search stats and do a little report?
14:52:48 <bcoca> glad to see you pushing the bar, in general we have great docs compared to almost everyone else already, proprietary or oss, but that you still make em better is really nice
14:53:34 <acozine> bcoca: thank you, we are standing on the shoulders of giants, or at least of people who cared about documenting things well
14:54:08 <bcoca> and plenty of typos ...
14:54:15 <acozine> ah, well, we all make those
14:55:00 <acozine> #topic open docs PRs
14:55:15 <acozine> we're back up above 100
14:55:37 <acozine> https://github.com/ansible/ansible/pulls?q=is%3Aopen+is%3Apr+label%3Adocs
14:55:54 <acozine> does anybody on the channel have an open PR you'd like to highlight?
14:56:23 <cbudz_> Not presently but I have time this afternoon and tomorrow afternoon to do some review work
14:56:38 <acozine> bornjre: brlin bvitnik cyberpear dfed[m] felixfontein jhawkesworth madonius mrproper Pilou shaps tributarian Xaroth xenlo zbr zoredache
14:56:38 <samccann> #info docs PRs above 100... review review review please!
14:56:56 <acozine> cbudz_: sounds great, thank you
14:57:51 <acozine> samccann: this one looks like it's in your area of expertise: https://github.com/ansible/ansible/pull/66644
14:58:45 <acozine> looking at it in more detail, I wish we would update the Galaxy UI to use the same phrase
14:59:50 <samccann> I'll take a look after this meeting.. thanks
14:59:52 <acozine> if the argument is `--token`, and the docs say `API token`, then the button you click should say `API token`
14:59:56 <acozine> samccann: sounds good
15:01:52 <acozine> huh, anybody on the channel with Windows experience/knowledge?
15:02:05 <acozine> this one looks simple, but I have no idea if the change is correct
15:02:07 <acozine> https://github.com/ansible/ansible/pull/66658/files
15:02:42 <acozine> it changes `HKLM:Software\Microsoft\Windows\CurrentVersion\Uninstall` to `HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall`
15:02:59 <acozine> adds a backslash
15:03:09 <samccann> sadly don't have access to a microsoft laptop anywhere.
15:03:22 <acozine> it looks plausible, but since I don't know what HKLM is . . .
15:03:47 <samccann> this looks like the change is correct - https://support.microsoft.com/en-us/help/247501/how-to-manually-remove-programs-from-the-add-remove-programs-list
15:04:18 <samccann> and it spells out HKLM I think. So I'd be inclined to approve/merge
15:05:11 <acozine> samccann: thanks for doing the research
15:05:30 <acozine> how do we feel about this one? https://github.com/ansible/ansible/pull/66622/files
15:05:53 <samccann> am I okay to merge that windows one?
15:05:54 <cbudz_> I was just leaving a comment on thqt one
15:06:02 <acozine> samccann: yep, go for it
15:06:05 <cbudz_> on 66622 that is
15:07:03 <acozine> samccann: oh, weird, I just re-read that page you found, and it doesn't have the `:`
15:07:16 <acozine> https://www.irccloud.com/pastebin/hf7blqV5/
15:07:35 <acozine> cbudz_: awesome, what are your thoughts on it?
15:07:36 <samccann> dang just merged
15:07:40 <acozine> nah, that's okay
15:07:58 <acozine> the person who submitted it deserves credit for realizing the existing docs were wrong
15:08:11 <acozine> we can remove the `:` in a separate PR
15:09:24 <acozine> huh, I thought we'd caught all the places where the paths to the test files needed updating
15:09:25 <cbudz_> acozine: I requested that the "If you care about code quality" statement be rephrased
15:09:32 <samccann> I'm asking the OP now. I'll open a separate PR
15:09:35 <cbudz_> its rather passive aggressive
15:09:36 <acozine> cbudz_: ah, good thinking
15:09:52 <cbudz_> there should ideally be conventions for that sort of thing to point users to
15:10:05 <acozine> yeah, we don't judge - ansible is all about "do it your way"
15:10:15 <acozine> if it works, and it works for you, it's all good
15:10:48 <cbudz_> gotcha
15:10:54 <acozine> re: test paths - we've got another PR https://github.com/ansible/ansible/pull/66626/files
15:12:18 <acozine> ah, these changes are down in the sanity test folder
15:12:25 <samccann> should be easy enuf to validate right?
15:12:40 <acozine> yeah, they look correct on first glance
15:12:58 <acozine> I was just surprised because I thought I'd grepped for the old path and fixed everything
15:13:01 <samccann> and can verify in the background while you move on to the  next one
15:13:01 <acozine> but apparently not
15:13:18 <acozine> samccann: awesome, thanks
15:13:59 <acozine> as usual, we have some that are docs AND code
15:14:16 <acozine> for example https://github.com/ansible/ansible/pull/66612
15:14:42 <acozine> I'm going to keep scanning down the list for docs-only ones
15:16:29 <acozine> This one seems like a good change: https://github.com/ansible/ansible/pull/66490/files
15:16:55 <acozine> adding the name of the example playbook into the example filetree lets people see what we mean by "playbook-adjacent"
15:17:30 <acozine> oh, I see, it was already there, this just changes the formatting
15:17:38 <acozine> still, I think it's a bit clearer this way
15:17:45 <cbudz_> new formatting is much cleaner
15:18:14 <samccann> LGTM
15:19:52 <acozine> merge that PR!
15:20:01 <acozine> here's an interesting one: https://github.com/ansible/ansible/pull/66139/files
15:21:02 <acozine> the information looks useful - I might add a title above the paragraph, since it isn't really part of documenting your plugin
15:21:18 <cbudz_> agreed
15:21:31 <cbudz_> It should be a prescribed best practice
15:22:09 <samccann> i'm not sure the list works the way it's written (rst thing). I think it needs a LF between the lead in sentence and the bullet list
15:22:17 <cbudz_> also based on the information presented in the bullet points, should this be added to 'options' under modules?
15:22:41 <cbudz_> ooops, must leave to prepare for platform docs group meeting
15:22:47 <acozine> cbudz_: no, these options aren't available for modules
15:22:54 <acozine> only for other plugin types
15:23:13 <acozine> cbudz_: thanks for coming, have fun in your next meeting
15:23:18 <cbudz_> that sentence leading into the bullet points needs to be rephrased in that case
15:23:42 <acozine> all right, we found a couple we could merge or at least work with
15:23:53 <acozine> and we've only got 7 minutes left
15:24:06 <acozine> in case some folks have been lurking . . . it's time for
15:24:16 <acozine> #topic open floor
15:24:26 <acozine> all comments welcome
15:24:36 <acozine> ask any question
15:24:45 <acozine> bring up any issue
15:24:59 <acozine> argue in favor or against any PR
15:25:11 <acozine> this is your chance, folks!
15:25:34 * acozine turns on recording of crickets
15:26:01 <acozine> maybe it's just January
15:26:28 <acozine> but cold weather and dark skies mean it's time to huddle by the computer . . .
15:26:47 <acozine> yet it's incredibly quiet here
15:26:57 <samccann> speaking of cold.. .was freezing in my home office until I realized I never turned the heat up this am.  61 deg!
15:27:05 <acozine> ooph, that's cold
15:27:37 <acozine> you have a manual thermostat still?
15:27:40 <acozine> that's old school!
15:27:54 <samccann> heh yep
15:28:25 <samccann> I put it down at night, turn it up when I wake up.  (or you know, when my teeth chatter and I realize I haven't turned it up)
15:28:38 <acozine> heh, nice
15:28:55 <acozine> in our building turning the heat down only works up to a point
15:29:08 <acozine> because the neighbors like to keep their apartments warm
15:29:37 <acozine> and their heat rises into our apartment
15:29:55 <samccann> saves you some $$
15:30:19 <acozine> yep, though I feel kind of sorry for the people upstairs from us
15:30:33 <acozine> I hope they like it a bit on the colder side, like we do
15:30:41 <samccann> heh
15:30:55 <acozine> and there it is - the Hour of Documentation is over
15:31:19 <acozine> thanks everyone, see you next week for the next exciting installment of DaWGs in Cyberspace!
15:32:31 <acozine> as always, feel free to add topics to the agenda by editing the latest comment on (or adding a new comment to) https://github.com/ansible/community/issues/389
15:32:36 <acozine> #endmeeting