16:00:39 #startmeeting Documentation Working Group aka DaWGs 16:00:39 Meeting started Tue Jan 3 16:00:39 2023 UTC. 16:00:39 This meeting is logged and archived in a public location. 16:00:39 The chair is samccann. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions. 16:00:39 Useful Commands: #action #agreed #halp #info #idea #link #topic. 16:00:39 The meeting name has been set to 'documentation_working_group_aka_dawgs' 16:01:12 @room Meeting time! Who is here to talk the docs? 16:01:13 o/ 16:01:13 Raise your ascii hand (o/) to say hi or any other way you want to let us know you are here. And Welcome to any new folks! 16:01:14 #chair Don Naro 16:01:14 Current chairs: Don Naro samccann 16:01:19 hey and we will even have meeting minutes tthis time! 16:01:21 o/ 16:01:38 To any newcomers - again, welcome. We chair all attendees as a way of recognizing your time spent here. And it opens it up for people to add to the meeting minutes with commands like #info or #link (to add a link) 16:01:38 o/ 16:01:41 #chair briantist tremble 16:01:41 Current chairs: Don Naro briantist samccann tremble 16:01:57 General run of the meeting - We go over action items, give docs updates.. maybe have a topic or two, and go over doctooling updates (all the fun stuff behind the scenes that get us docs.ansible.com!) 16:02:09 felixfontein: around to talk docs today? 16:02:16 Official agenda is https://github.com/ansible/community/issues/678 16:02:27 notice it's a new agenda link for the new year ^^^ 16:03:03 speaking of which... 16:03:04 #action samccann to change ...something... so autobot messages on docs issues point to new agenda. 16:03:09 #topic Action Item updates: 16:03:26 #info open - oraNod - to look into getting community maintainer(s) for the sphinx ansible theme 16:03:36 I think that's still open, right Don Naro ? 16:04:26 I think so. honestly struggling to get my brain back to 100% on everything 16:06:53 yeah same here. 16:06:54 is there an issue associated with that one? 16:06:54 no just an action item. Can you open an issue on the community project for that one pls? 16:06:55 yeah, that'll be better so we can track it 16:06:56 https://github.com/ansible-community/community-team/issues/ 16:06:56 yeah, I need to stop depending on action items in meeting minutes lol. thanks 16:06:57 #info open - samccann flesh out the personas by completing the todo items and putting them in a detailed slidedeck that describes each. 16:07:10 I don't think felixfontein is around and I lost track so will just include this as an info so we don't forget - 16:07:11 o/ 16:07:20 sorry, got a bit sidetracked... 16:07:23 #info open ansible/ansible docs issue to add links to the new collection envvar index page after the next antsibull-docs release 16:07:24 oh haha... 16:07:26 #chair felixfontein 16:07:26 Current chairs: Don Naro briantist felixfontein samccann tremble 16:08:27 yeah, I still plan to create a PR for that :) 16:08:48 * samccann just spilled water over her keyboard 16:08:49 * samccann can't find the dang cloth she keeps around for just such an occurance... brb 16:09:21 7c 16:09:23 woopsie 16:09:34 ok back in action... if a little keyboard ..misty 16:09:48 wb :) 16:09:50 ok thanks felixfontein 16:10:01 at least it's only water, sticky liquids are worse 16:10:08 heh new year starting off w/ a bang 16:11:18 I tried something during the winter break: https://github.com/ansible-community/antsibull-docs/pull/90 - this PR shows the callback type on a callback plugin's page, and provides indexes of callback plugins by type 16:11:20 so very true 16:11:20 lol I spilled a jar of honey all over my keyboard brb 16:11:21 heh 16:11:54 #info feedback wanted on https://github.com/ansible-community/antsibull-docs/pull/90 16:12:37 cool that looks good! 16:14:21 what I mainly was wondering about is what's actually the difference between notification and aggregate callbacks, I couldn't find anything on that in the docs (or in the code). I think from ansible-core's point of view it doesn't distinguish between these two types 16:14:25 I'll poke around a bit after the meeting but so far looks great 16:14:26 #topic doctools 16:14:26 since that's what we're talkingabout 16:17:49 if anyone has better ideas for the text / section in serted in the callback plugin docs page for every callback type, please add suggestions to the PR :) 16:17:51 so are you wondering if it's worth distinguishing them in the index pages? 16:18:29 I think distinguishing them makes sense, but we should really document somewhere what these types mean 16:18:43 bcoca: do you happen to know? 16:18:54 (if you are around...) 16:19:25 * bcoca injects more coffee in IV 16:20:28 aside from 'stdout' most of the other types of callbacks wil lnot affect core code are are more 'informational' , notification was supposed to be for callbacks that 'notify other systems/apps/apis' while aggregate are those that add info to sdtout one 16:20:50 ah, good to know 16:20:50 all documented in my head .... 16:20:53 :) 16:20:59 yeah, is hould write it up 16:21:05 and let people add other types 16:21:13 I'll probably create a PR for ansible-core docs to add that, I will ping you and the docs team for it 16:21:26 works4me! 16:21:34 #action write up what the different types of callback mean. aka notification was supposed to be for callbacks that 'notify other systems/apps/apis' while aggregate are those that add info to sdtout one 16:21:35 right now no other types are allowed (ansible-test validate-modules and antsibull-docs only allow these three) 16:21:51 cool thanks felixfontein ! 16:21:55 i was expecint the types to grow .. but seems my initial set just was enough for all 16:22:47 i've seen a couple of callbacks that could be called diff types (like one that gets kerberos ticket to inject into winrm) 16:24:16 maybe we should at least add another category 'other', and add more when explicitly requested? 16:25:33 idk, we should discuss that as it's own followup ... its been a long time and no one requested (but also not documented/explained anywhere ....) 16:26:27 I agree on that being a followup 16:29:09 ok are there other doctools topics today? briantist did I see a PR from you in the scrollback about..erm.. something_init? 16:29:43 samccann: yeah felixfontein already addressed it :) 16:29:50 woot! 16:30:02 okay anything else in docstools land to chat about? 16:30:05 it was about `antsibull-docs sphinx-init` and the generated bash script not hardcoding the path 🙌 16:30:22 coolness 16:32:35 #topic Documentation updates 16:32:38 erm.. not that I can remember anything. 16:33:08 We have the usual stuff - personas, archiving old docs, plots and schemes to take over the universe one docsite at a time... etc 16:33:23 #info looking for feedback on how to open up the docs publishing pipeline - https://github.com/ansible-community/community-topics/issues/174 16:34:05 oh.. and there's a contributor summit coming up? Did I see that message fly by somewheres?? 16:34:38 yeah I think cybette mentioned that in a different chat 16:34:43 ah here we go - https://hackmd.io/@ansible-community/cs202302-planning 16:34:53 And felix and Briantist are already there...woot! 16:35:35 Don Naro: we should think Deep Thoughts (tm) about if there's something we want to present as well. 16:35:57 Like is that a good time to do a show n tell on the proposed personas (assuming I flesh out the details more by then?) 16:36:52 I think that would be a good time to get into those details + how the personas tie into the docsite revamp that I mentioned before the break 16:37:46 #action samccann dnaro - to figure out a discussion or two for Contrib summit on personas and docsite revamp 16:38:07 samccann: by any chance have you noticed this issue yet? https://github.com/ansible/ansible/issues/79645 16:39:45 I was looking at it and thinking about how to respond with something along the lines of "we've got several efforts underway to better connect users with content in the docs" 16:40:02 not sure I could have phrased things without making it sound too convoluted right now but this issue sort of highlights the need for persona to journey mapping and all that good stuff 16:40:07 well on first pass - the PR should be on the new public docsite not in ansible/ansible if I'm reading it correctly 16:40:23 yeah there is that too 16:41:13 anyway I'm probably derailing things a bit. yeah, I think it'd be great to have some of the efforts we've been discussing at the summit. 16:41:56 I def want to use the opportunity to make sure things align with community needs too 16:41:57 nah not derailing at all. It's good to highlight important/interesting issues or PRs here. 16:42:17 I'll work on moving the issue to the docsite repo. I 'think' there might be some automagic way to do that in github since they are both under the ansible org 16:42:50 #topic OpenFloor 16:43:03 This is the time to bring up anything docs related that's on your mind... 16:48:55 ok things a bit quiet as we all get back into the groove in this glorious new year 16:48:56 I'll end the meeting if no one else has a topic today 16:48:57 nothing from me. I need to detox a bit more before I can really get docs back on my mind. 16:49:11 and get stronger coffee 16:49:11 * samccann wonders how much 🥃caused that need to detox 16:49:19 ;-) 16:49:32 * samccann realizes that little jab is now in the official meeting logs for posterity 16:51:57 lol. no offence taken. there was booze involved but I was mostly talking about all the food. 16:51:58 heh 16:51:58 #endmeeting