15:31:15 #startmeeting Docs Working Group 15:31:15 Meeting started Tue Jan 22 15:31:15 2019 UTC. 15:31:15 This meeting is logged and archived in a public location. 15:31:15 The chair is acozine. Information about MeetBot at http://wiki.debian.org/MeetBot. 15:31:15 Useful Commands: #action #agreed #halp #info #idea #link #topic. 15:31:15 The meeting name has been set to 'docs_working_group' 15:31:31 welcome back! 15:31:35 thanks! 15:31:58 * gundalow waves 15:32:05 arrived in Minneapolis last night after ~22 hours in transit, so I'm a little jetlagged 15:32:14 #chairs samccann gundalow 15:32:20 ??? 15:32:24 #chairs 15:32:25 * alongchamps waves 15:32:34 #chair samccann 15:32:34 Current chairs: acozine samccann 15:32:41 #chair gundalow alongchamps 15:32:41 Current chairs: acozine alongchamps gundalow samccann 15:32:58 who else is around? 15:33:16 hi alongchamps and welcome! 15:33:28 clearly I have lost my IRC touch 15:33:37 thanks! 15:34:39 #info Agenda https://github.com/ansible/community/issues/389 15:34:53 I see we have an agenda item about working groups - whether/how to fill in the documentation about them 15:35:07 #topic Working Group docs 15:35:25 #info Currently we have https://docs.ansible.com/ansible/devel/community/communication.html#working-groups 15:35:27 though 15:35:27 current documentation is minimalist: https://docs.ansible.com/ansible/devel/community/communication.html#working-groups 15:35:32 gundalow: jinx 15:35:47 1) Not all Working Groups have IRC channels (or for that matter meetings) 15:36:09 2) The number of Working Groups has grown a lot (not all are listed on that page), and will continue to grow 15:36:26 3) No details of what a Working Group is, how to get involved, that any help is welcome, etc, etc 15:36:32 So I'm wondering about 15:36:43 A) Creating community/working_groups.html 15:37:18 we have some of that content here: https://github.com/ansible/community/blob/master/WORKING-GROUPS.md 15:37:19 B) ^ will contain a list of Working Groups, grouped-by category (Cloud, OS, cross-functional, etc) 15:37:38 and we link to that from the communication page 15:37:53 I'm not opposed to creating a new page in the docs 15:38:01 the forth bullet poing on the workging-groups.md isn't being followed (aka not all WG have a dedicated wiki page) 15:38:21 I'd like to limit duplication (and maintenance) though 15:38:26 C) working-group.html will also contain the motivational & overview bits of working group 15:38:29 if they all did, then we could just group WG by a logical set of categories and then the link to the wiki page would cover the details 15:38:58 samccann: interesting - do we have a Wiki page? 15:39:03 DaWGs, I mean 15:39:06 I personally like the main WG info to be on docs.ansible.com, longer term I'd like to link from more modules to WG's etc 15:39:13 for docs, yes, I think thanks to gundalow 15:40:16 gundalow: the drawback with that is then we (docs) become responsible for that content per working group. By having it in the wiki page they are all supposed to have, the onus is on the WG to maintain that content 15:40:41 the working groups would know best, but perhaps we start with some sort of stub / minimum required info 15:40:49 samccann: ah, sure, I should clarify that I'm not expecting WG specific information (apart from names) to be on docs.ansible.com 15:40:51 it's also scalable as the number of groups grow 15:41:05 all the WG specific info should be on gh/ansible/community/wii 15:41:08 wiki* 15:41:11 I think we can host the general information on WGs on docs.ansible.com - what is a WG, how to join, how to start a new one, etc. 15:41:21 +1 15:41:22 and we gently nudge those who don't have the wiki to create one? 15:41:31 without getting too much into maintenance of individual group info 15:41:37 acozine +1 15:41:51 samccann +1 15:42:11 gundalow: can you think of other existing content that should be folded in? 15:42:26 #action gundalow to create the most minimal `community/working-group.rst` page which lists the WGs by category 15:42:39 on the community repo or blog posts or anything like that? 15:43:26 background: I'm giving cutdown Community Webinary at AnsibleAutomates London on Monday 28th, so I want to get minimal docs live this week 15:43:37 acozine: how do you mean? 15:44:15 are there other pages/resources elsewhere that talk about WGs? 15:44:40 ah, zero blog posts at the moment. Though I see blog posts in my future 15:44:40 that we should remove or slim down when we merge the new `working-group.rst` page? 15:44:59 Magic Eight-Ball says . . . Very LIkely 15:45:01 ah, I see what you mean 15:45:14 Nothing springs to mind at the moment 15:45:24 okay, cool 15:45:46 Cool, I'll create a minimal PR, and once the basic page is live we can update over time 15:46:01 when you've got content ready, ping us - should be an easy merge 15:46:08 Thanks :) 15:46:21 alongchamps: you have anything on your mind? 15:46:23 That's all I had on that 15:46:25 PR to shepherd? 15:46:34 question to ask? 15:46:51 #topic open floor 15:47:02 nothing from me, I'm mostly watching and getting used to the meetings 15:47:36 sounds great - let us know if you come up with ideas for making the channel or meetings more welcoming 15:48:00 #topic PR reviews needed! 15:48:23 We're at 96 open PRs marked `docs` 15:48:39 this might be a good time to confess my worries wrt merging doc prs 15:48:39 #topic Docs PR review 15:48:46 samccann: Sure 15:49:12 I am reluctant (due to some embarrassing bad merges on my part) to merge anything that isn't an .rst page change that I understand 15:49:35 samccann: embarrassing bad merges - we've all done them 15:49:42 which brings that 96 open prs down to something like 12 (last time I tried a limited search 15:49:45 samccann: Is that a 1) Git(Hub) issue, or 2) a content issue? 15:49:59 Git by name, git by nature 15:50:04 HAHAH 15:50:22 ok so I merged a PR with code in it, which I know now to avoid 15:50:39 I backported a feature, merged a bunch of bugs (even in the rST), and have generally run amok at various times 15:50:42 but if the PR is in a module, even if it's only the docstring in that module - how do I know I can merge it? 15:50:42 acozine: we have another meeting in 10 minutes 15:50:49 samccann: ask 15:50:49 the beauty of git is, it's all recoverable 15:50:54 acozine: +1 15:51:08 high level rule is: no feature to be backported 15:51:41 it's kind of like falling off when riding - you're not really a rider until you've eaten dirt a few times 15:52:14 and you're not really a committer until you've screwed up some merges 15:52:46 but to answer your question about PRs that change the docstrings 15:53:03 o/ 15:53:21 #chair dag alongchamps 15:53:21 Current chairs: acozine alongchamps dag gundalow samccann 15:53:32 you can build the module and visually check it 15:53:39 and you can ask maintainers for reviews 15:53:49 ultimately it's about trust, I think 15:53:52 hey, dag! 15:54:12 yeah it's the technical nature of the change that worries me. So seems I should cc/request review from the maintainer (whatever github suggests) 15:54:37 acozine: samccann One things we may need to think about is having some other people from Core/Community around when we do doc PR triage 15:54:51 yeah, requesting reviews via github is good, and/or posting a request on IRC 15:55:05 We need to ensure that older versions of the documentation include the latest WG information, if we keep the list in the docs 15:55:12 gundalow: agreed, but we (acozine and I) are also in there regularly trying to tame the beast of growing backlog 15:55:22 (like we need this for other information as well, releases, etc.) 15:55:31 (as in got a spare 30 min? try to merge a pr or two) 15:55:57 dag: this brings us back to the question of whether we can have some content that isn't versioned amidst the versioned content 15:56:03 but in general I got my answer thanks 15:56:42 dag: gundalow: for the current update to the WG info, I think we can just backport the page 15:57:02 * dag would like to fix the current Wiki index, it now contains sub-documents for specific technologies, it would be better if we only listed the main topics (now that we have more WG's) 15:57:07 * gundalow personally doesn't want `/community/` versioned, or if we do big red text that says "This isn't latest" 15:57:33 gundalow: agreed, I would rather have a redirect to the devel version for that part 15:57:39 * gundalow has another meeting in 3 minutes I need to swap to 15:57:52 (or proxied for that matter) 15:58:11 nod, we have an issue for that 15:58:18 dag: I agree, but only if we can keep the context for anyone who was looking at an older version and navigates back to the module docs 15:58:34 acozine: a redirect should work fine for going back 15:58:38 I wonder if it would be worth adding some details to the DaWG wiki for the 2019 aims? 15:58:42 or, as gundalow says, a big red banner 15:58:51 gundalow: good idea 15:59:17 gundalow: Or you ok if I clean up the Wiki index to only include one page per WG ? 15:59:23 s/one page/one link/ 15:59:24 I'm working on a 2019 priorities list for docs - I'll publish it there 15:59:39 gundalow: I will make sure that one page also has links to the sub-pages 15:59:45 acozine: \o/ 16:00:32 dag: I think a single link only on the main page of wiki is OK 16:00:58 Also I'm tempted to clear out the `group-`${WG}` directories that aren't used 16:01:02 * gundalow has to drop 16:01:20 gundalow: I was also thinking of adding a section-header (Ansible / Cloud / Networking / System / Other) 16:01:42 gundalow: yeah, I don't see the benefit at this point, it's harder to maintain as well 16:01:49 dag: I think that aligns with gundalow's original ideas 16:01:59 * acozine also has to drop off 16:02:01 meanwhile I think we've lost him and acozine to an overlap meeting 16:02:08 thanks everybody! 16:02:19 and look at some PRs if you have spare time today! 16:02:22 Do we have other topics we want to continue discussing? 16:02:25 all reviews welcome 16:03:40 dag: gundalow gave himself an action item earlier on here, so please coordinate so you're not both changing the same thing? I lost track whether you were thinking about a different page than he was thinking about 16:04:22 samccann: I was already editing while missing this meeting :-/ 16:04:32 heh 16:04:49 planning to make a screenshot to show him 16:04:56 sounds like a plan 16:05:34 #action all - please review the PR backlog for docs 16:05:39 #topic Open Floor 16:05:49 do we have anything else to chat about here today? 16:07:10 ok seems silent... I'll end this meeting 16:07:17 in 3... 16:07:28 2... 16:07:44 1... 16:08:13 #end 16:08:18 heh #endmeeting 16:08:29 #endmeeting