16:01:54 #startmeeting Documentation Working Group aka DaWGs... (full message at https://libera.ems.host/_matrix/media/r0/download/libera.chat/18f89f3e2b8171212d1adc29780a2124eadc5840) 16:01:54 Meeting started Tue Dec 21 16:01:54 2021 UTC. 16:01:54 This meeting is logged and archived in a public location. 16:01:54 The chair is samccann. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions. 16:01:54 Useful Commands: #action #agreed #halp #info #idea #link #topic. 16:01:54 The meeting name has been set to 'documentation_working_group_aka_dawgs..._(full_message_at_https://libera.ems.host/_matrix/media/r0/download/libera.chat/18f89f3e2b8171212d1adc29780a2124eadc5840)' 16:02:11 * samccann ponders if that big ol cut n paste worked 16:02:21 hm 16:02:24 #chair acozine Gwmngilfen 16:02:24 Current chairs: Gwmngilfen acozine samccann 16:02:38 the `@room` mention pinged me, but the name mention in the opening comment did not 16:03:26 briantist: tadeboro you around for docs chat and virtual eggnog? 16:03:39 yeah I probably need to add the @ in front of each 16:03:51 o/ 16:03:57 it didn't set the topic either 16:04:00 at least, I don't think it did 16:04:18 #chair briantist 16:04:18 Current chairs: Gwmngilfen acozine briantist samccann 16:04:28 #topic opening chatter 16:04:49 ah well, big old block of copy pasta doesn't work as well as I thought it w ould 16:05:18 * gwmngilfen-work wonders when Fedora will do a native Matrix zodbot... 16:05:34 #info agenda - https://github.com/ansible/community/issues/579#issuecomment-993844821 16:05:47 am dealing with a `setuptools` issue for the time being, seems suddenly it "can't be found" on all of our CI pipelines 16:05:56 I don't expect we'll cover much this week with so few folks around, but we can pick and choose from the agenda 16:05:56 (not docs/ansible related) 16:06:19 well the ansible/ansible CI is misbehaving quite a bit of late as well. 16:06:22 briantist: that sounds dire 16:06:47 I've got at least 3 PRs ready to merge but no amount of hammering on CI reruns is getting them to pass. Gremlins in the system 16:07:01 (or possibly elves using the CI to make toys? 16:07:06 it seems like it could be related to `setuptools` version 60, so it may be larger than just my stuff :-/ 16:07:10 what is it failing on? timing out / running out of memory? 16:07:13 * make toys?) 16:08:09 who knows. core folks (at least brian) is aware. not sure how many others are around this week. 16:08:31 that's odd - I merged briantist's suggested change to my "why use roles" PR and it passed CI this morning 16:08:39 https://github.com/ansible/ansible/pull/76560 16:08:56 ooo is your PR ready to merge??? 16:09:15 well, for suitably restricted meanings of "ready" . . . yes 16:09:25 I am pondering the questions you put on it samccann 16:10:17 do you want it to linger a bit while you ponder, or are you considering a separate PR if anything comes of the ponder? I'm fine either way 16:10:35 well, I think you raised some interesting points 16:11:08 #topics Documentation updates 16:11:10 but at the same time, the basic message stays the same - roles help you organize complex automation 16:11:14 dagnammit 16:11:19 #topic Documentation updates 16:11:24 but everyone decides for themselves what counts as "complex" 16:11:50 heh 16:12:41 ok so I guess my questions remain - would I use a role for a reason OTHER than sharing it with someone else? 16:13:03 I'd say yes - I've used roles for my personal consumption when the playbook just got too unwieldy 16:13:13 ok cool 16:13:52 ok I'm thinking we merge and close the issue. And see if we get more feedback later. 16:13:55 I'd also say the use of default vars is an advantage 16:13:59 yes absolutely would use roles other than for sharing 16:14:12 it's encapsulation, organization of files, etc. 16:14:22 you can provide a value that gets used for general cases, while still allowing for overrides 16:15:01 @smccann:matrix.org cyb-clock chimes Fifteen exciting, thrilling minutes have slipped by whilst we plot to take over the universe, one doc at a time! 16:15:56 merged 16:16:43 thanks! 16:17:17 I still don't understand why it passed CI, though 16:17:21 when other PRs are failing 16:17:27 it's random 16:17:34 sometimes it works, sometimes it doesn't. 16:17:40 a problem for the New Year! 16:17:41 ah, gremlins for sure, then 16:18:02 #info some community topics relating to docs. Please add your comments to each - https://github.com/ansible-community/community-topics/issues/created_by/samccann 16:18:24 Those cover the Great Debate on FQCN for built in modules, semantic markup, and community examples repo 16:18:34 hmm.. actually that last one is mostly settled. 16:18:59 I like the `being_implemented` tag 16:19:11 anyone feel like this is worth keeping open though? - https://github.com/ansible-community/community-topics/issues/39 16:19:40 or maybe I'll jsut ping felix etc and see if it can be closed now. I don't want to mess up any reporting etc they are doing there. Unless Gwmngilfen happens to know? 16:20:08 I'd wait until after the New Year, but I think we can probably close it soonish 16:20:16 kool 16:20:18 does the new repo have a good README? 16:20:26 * gwmngilfen-work does not 16:20:27 #info some easyfix docs issues if anyone is in the mood - https://github.com/ansible/ansible/issues?q=is%3Aopen+is%3Aissue+label%3Aeasyfix+label%3Adocs 16:20:54 like, if we advertise this in the Bullhorn, would folks be able to learn about contributing? 16:20:55 The new repo is still a WIP for sure but we have a couple of open issues there for example suggestions 16:21:56 yeah, I see Andersson007 has a to-do item for "Complete README" 16:22:10 we should do that before we close the discussion topic 16:22:35 yeah there's a lot we don't know yet. I think once we work through the first few examples we can come up with a helpful readme 16:24:14 #info we are down to 4 open issues to cover last year's Docs survey feedback! Help wanted on any of these - https://github.com/ansible/ansible/issues?q=is%3Aissue+is%3Aopen+survey 16:24:44 and one of those is `being_implemented` :-) 16:25:01 well, issue 75507 is the examples repo . . . 16:25:05 heh, exactly 16:25:35 oh, and one of them isn't marked `Docs survey feedback` at all 16:25:42 yeah it has a few ideas 16:25:45 though maybe that's where it came from 16:25:49 really? which one? 16:26:18 oh mine ..doh! I'll update the title 16:26:47 it came from the contrib summit, not the survey 16:26:53 oh yeah.. so I'll leave the title 16:27:29 flipping the topic switch 16:27:35 #topic docs tooling updates 16:28:05 somewhere in the ether I think Felix already has a PR in the works that will add the list of new collections to the start of the Ansible porting guide! 16:28:57 #info looking for feedback on semantic markup specification - https://hackmd.io/VjN60QSoRSSeRfvGmOH1lQ 16:29:32 The hope is to capture what we want from the community side, and then get RH internal involved for the downstream products this impacts. Slow process but still push push pushing it along 16:30:00 @smccann:matrix.org cyb-clock chimes Fifteen exciting, thrilling minutes have slipped by whilst we plot to take over the universe, one doc at a time! 16:30:02 * samccann hopes there isn't a sysyphus aspect to this effort 16:30:54 yeah, that's a long-running effort 16:30:59 long-long-long-running 16:31:35 Gwmngilfen: I added to the Help Wanted section of the upcoming bullhorn to list easyfix issues. Is that something I need to add weekly now with newsbot or is there a way to make that a permanent thing? We could add core easyfix as well since there may be a few of those around 16:31:36 heh 16:31:57 only been a year acozine... 16:32:04 * samccann being sarcastic 16:32:24 i've had projects > 4 yrs and coutning in queue 16:32:57 haha yeah I saw some when I was going through old PRs bcoca 16:33:08 decided not to send you the annual nagogram comment this year ;-) 16:33:22 specially since CI is borked 16:33:23 the news queue is cleared after each release, so you'd have to log a new item 16:33:44 s/release/edition 16:33:50 when is release day Gwmngilfen so I know when to repeat myself? 16:34:12 it was going weekly soon, right? 16:34:27 cybette should be able to answer that, but I believe the intention is for weekly in the New Year 16:34:35 ok cool 16:34:51 I can probably then just start posting it on Tuesdays after this meeting 16:35:07 samccann: usually thursdays, but this week it'll be going out later today. maybe you can use remindbot to mention newsbot weekly ;) 16:35:13 oh, we should also close out the 2021 agenda ticket and open a 2022 one 16:35:27 oooo oooo cybette that would be great! 16:35:44 #action samccann find a way to use remindbot with newsbot to add Help Wanted on easyfix items each week 16:36:07 #action samccann close out 2021 DaWGs agenda issue and create a new on for the new year 16:36:11 and even if we don't go weekly right away, it's trivial to remove a duplicate entry. 16:36:51 so automate away with the bots! 16:37:17 woot! 16:37:33 #topic Open Floor and eggnog time! 16:37:40 * gwmngilfen-work generally oesn;t want bots logging news, but in this case I see the point :P 16:37:48 * gwmngilfen-work * generally doesn't want bots logging news, but in this case I see the point :P 16:38:14 Gwmngilfen: i'll run it by you before I do it. I'm thinking maybe just one post for all easyfix items (not separating docs from coding ones) 16:38:50 mmm, eggnog 16:38:56 🍹 16:38:57 happy holidays everyone! 🥳 16:39:12 🍸️ 16:39:24 I have a recipe for home-made eggnog that involves whipped cream. It is truly a meal in a glass. 16:39:31 and so, so tasty 16:39:33 #info no DaWGs meeting next week. Very few folks will be around 16:39:37 * gwmngilfen-work had to give up alchol some years ago 16:39:40 yum yum! 16:39:53 Gwmngilfen: the recipe is alcohol-optional 16:40:02 ooh, you win that one 16:40:02 yeah I'm pretty close to that as well Gwmngilfen - I think it triggers migraines for me now 16:40:06 we made it without for all the years the nephews were underage 16:40:08 i have gout :/ 16:40:23 and I'll probably do it "spike your own" again this year 16:40:32 hah sounds tasty 16:40:50 Gwmngilfen: oof, that sounds painful 16:41:01 The floor is open btw, if anhyone is lingering, feel free to bring up a topic, say hi, or just sip some virtual eggnog to end out the year with us! 16:41:32 too busy to do much else than say "hi" and "happy holidays!" 16:41:49 happy holidays briantist ! 16:42:05 happy holidays briantist! 16:42:05 acozine: havent had an attack in over a year, but yeah, it's not fun 16:42:21 happy holidays briantist ! 16:43:00 #chair Carol Chen 16:43:00 Current chairs: Carol Chen Gwmngilfen acozine briantist samccann 16:43:09 never to late to be made furniture! 16:43:12 giving up alcohol was easier than giving up tasty food 16:43:15 heh 16:43:34 * gwmngilfen-work does a lot of cooking over this time of year 16:43:46 hehe I was just saying that I'm off to make dinner... chair for 2 minutes! have a great holidays everyone, take care, relax, be merry, see you in 2022! 16:43:59 happy holidays Carol Chen ! 16:44:01 enjoy Carol Chen !! 16:44:09 enjoy your time off 16:44:23 thanks, you too! cheers! 16:44:40 #unchair cybette 16:45:01 @smccann:matrix.org cyb-clock chimes Fifteen exciting, thrilling minutes have slipped by whilst we plot to take over the universe, one doc at a time! 16:45:05 * gwmngilfen-work is trying to finish up some survey work for Fedora 16:45:08 #unchair Carol Chen 16:45:08 Current chairs: Gwmngilfen acozine briantist samccann 16:45:15 there we go 16:45:38 Gwmngilfen: oof, we didn't do an Ansible Docs survey this year, did we? 16:45:42 well, maybe next year 16:45:47 we did not, correct 16:45:51 biennial . . . or is that biannual? 16:45:55 no I didn't want to do it until we trim down the existing items a bit 16:46:03 seems fair 16:46:13 fair enough . . . plus - pandemic! 16:46:19 yep 16:46:31 maybe springtime? 16:46:57 that could work 16:47:05 that may be optimistic actually, since we probably need the new stuff on /latest/ and letting the dust settle a bit 16:47:22 but we'll see 16:47:44 anecdotally, I'm seeing a minor uptick in Matrix traffic now that acozine's doc changes have moved from devel to latest :) 16:47:55 that's encouraging 16:48:06 well, that depends on your view, but I think so, yes :) 16:48:18 I noticed somewhere in the DaWGs stuff we mention IRC but not Matrix 16:48:27 sabotage! 16:48:30 should probably fix that for next year 16:48:35 heh 16:48:47 I think it was probably in the issue for the 2021 agendas 16:49:05 at the very top, from last January 16:49:06 lol 16:49:18 well, that's fair then :P 16:50:17 heh 16:51:38 ok about time to wind this down I guess 16:51:53 * samccann gulps last of her eggnog ... 16:52:22 #endmeeting