15:01:10 <samccann> #startmeeting Documentation Working Group aka DaWGs
15:01:10 <zodbot> Meeting started Tue Oct 18 15:01:10 2022 UTC.
15:01:10 <zodbot> This meeting is logged and archived in a public location.
15:01:10 <zodbot> The chair is samccann. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions.
15:01:10 <zodbot> Useful Commands: #action #agreed #halp #info #idea #link #topic.
15:01:10 <zodbot> The meeting name has been set to 'documentation_working_group_aka_dawgs'
15:01:23 <samccann> @room Meeting time! Who is here to talk the docs?
15:01:33 <samccann> 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!
15:01:35 <DonNaro[m]> o/
15:01:43 <samccann> #chair Don Naro
15:01:43 <zodbot> Current chairs: Don Naro samccann
15:02:03 <samccann> felixfontein: briantist - around to talk docs today?
15:02:18 <samccann> Official agenda is https://github.com/ansible/community/issues/643#issuecomment-1267321151
15:03:26 <samccann> ok might just be us talkin to ourselves today...
15:03:49 <DonNaro[m]> I hear the secrets that you keep, when you're talking in your sleep
15:03:57 <samccann> HAHAHA
15:03:57 <DonNaro[m]> 80's jam
15:04:04 <samccann> #topic Action Item updates:
15:04:10 <samccann> #info resolved open issues on impacted collections for filter/test plugins - https://github.com/ansible-community/community-team/issues/65
15:04:42 <samccann> #info open - Consider an 'open docs hr' later in the week to regularly interact with docs contributors in a friendlier way than the expert details that happen in DaWGs meetings
15:04:59 <samccann> #info open add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.
15:05:07 <samccann> So yeah... some open action items to work on :-)
15:05:17 <briantist> sorry no, I'm at fest
15:05:29 <briantist> so not attending today
15:05:34 <samccann> no worries, enjoy your time! say hi to folks for us!
15:05:43 <DonNaro[m]> enjoy fest briantist
15:05:59 <briantist> ty :)
15:07:11 <DonNaro[m]> samccann: for the sidecar docs there are a few add filter items open. what needs to happen to close those?
15:07:41 <DonNaro[m]> if Hacktoberfest is still on maybe we can add some of those items?
15:07:48 <samccann> so our goal - open issues on the collections impacted.
15:08:00 <samccann> We aren't fixing those collection issues, unless you wanna hop in and give some a try?
15:08:33 <samccann> They may not be rocket science. I haven't looked at the ones that are fixed. So we could potentially, yeah
15:08:40 <samccann> if the collection owners are amenable to that
15:09:11 <DonNaro[m]> I can take a look through but you've jogged my memory about getting the collection owners to look at them
15:09:19 <samccann> cool
15:09:58 <samccann> we do have a BUNCH of cleanup issues I still need to create against.. a... BUNCH of collections. Those might be hacktoberfest candidates for sure. Not sure I'll get them opened in time
15:10:11 <samccann> or stuff you can play w/ if you wanted to.
15:10:13 <DonNaro[m]> I'm looking at https://github.com/Infinidat/ansible-infinidat-collection/issues/17
15:10:32 <DonNaro[m]> would it be a good idea to maybe open a related issue at https://github.com/infinidat/ansible-infinidat-collection/issues ?
15:11:09 <samccann> um? that's where I opened it?
15:12:13 <DonNaro[m]> argh. what is wrong with me?
15:12:45 <DonNaro[m]> I'll go get my coat
15:12:46 <DonNaro[m]> and show myself the door
15:13:57 <samccann> LOL haveing that kinda day, eh?
15:14:48 <samccann> LOL haveing that kinda day, eh?
15:16:16 <DonNaro[m]> in fairness I was up at 4 this morning for no good reason
15:16:16 <samccann> meanwhile, back at the docs ranch, tiny tim fell down a collection welll
15:16:16 <gwmngilfen-work> i went to bed at 2 if we're sharing sympathy 😉
15:16:17 <DonNaro[m]> I think our new cat, Jinx, woke me up but I'm not sure
15:16:17 <samccann> ooooch. yeah that's painful
15:16:17 <gwmngilfen-work> but that was entirely self inflicted
15:16:17 <samccann> #topic Documentation updates
15:16:17 <samccann> #info 34 issues closed so far for hacktoberfest. Busy times!
15:16:17 <samccann> omgosh y'all need more sleep!
15:16:17 <gwmngilfen-work> the docs hacktoberfest success is entirely bullhorn-worthy btw
15:16:28 <samccann> yeah will do at the end of the month! We may yet sneak some more in... if we can open more tix
15:16:29 <DonNaro[m]> totally. the boolean values changes were a real win.
15:16:40 <samccann> omgosh yes!
15:17:42 <samccann> #info ansible-core beta staged at - http://docs.testing.ansible.com/ansible-core/2.14/
15:17:57 <samccann> I'll restage Ansible 7 later today. I needed to stage Ansible 6 to remove the fest banner and that's still running
15:18:09 * samccann too paranoid to go directly to prod so always stages to test first
15:18:50 <samccann> I was out for a week, so I'm not prepped for much else today. Any burning topics we can discuss?
15:19:32 <DonNaro[m]> redirects for the user guide should be in place
15:19:52 <samccann> oh cool! All merged etc?
15:19:57 <DonNaro[m]> Aine did a great job of testing them
15:20:03 <samccann> Aine FTW!!
15:20:11 <DonNaro[m]> Aine FTW!!
15:20:43 <DonNaro[m]> she needs go get on Matrix and hang out
15:20:50 <DonNaro[m]> I'm going to badger her about it
15:20:56 <samccann> hah for sure
15:21:18 <DonNaro[m]> so that should hopefully be it and we can close out that issue
15:21:35 <samccann> nice!
15:21:49 <DonNaro[m]> https://github.com/ansible/ansible/issues/78082 I think we can close this one now
15:22:59 <DonNaro[m]> oh, and I bet we could get a Hacktoberfest docs issue for Ansible-lint. some of the rules link to the user guide and we should update those.
15:22:59 <samccann> can you mark this PR - https://github.com/ansible/docsite/pull/110 to say it Fixes https://github.com/ansible/ansible/issues/78082 ?
15:23:20 <samccann> That way it will close automatically. But I don't think we can merge the redirects until Ansible 7 release day, right?
15:23:27 * samccann not sure her brain is back from PTO yet
15:24:44 <DonNaro[m]> right. I def wanted to check that about the redirects before merging. we can figure that out in the PR.
15:25:32 <jklech[m]> <acozine> "Ah,  I see what you mean about..." <- acozine: yes, i will update a couple of code blocks (meaning i will remove comments from the codeblocks and possible divide those blocks into more, as a result) and will open a PR with those changes
15:26:32 <samccann> Thanks @jklech:matrix.org !!
15:27:17 <samccann> Don Naro: - did we settle on a time to hold 'docs open office hrs' on Thursdays?
15:27:20 <samccann> I lost the plot on that one
15:30:15 <samccann> poke
15:30:31 <samccann> Don Naro: ^^ ? do you remember?
15:31:00 <DonNaro[m]> hey I don't think we settled on a time
15:31:04 <samccann> ok.
15:31:57 <DonNaro[m]> I think it'd be worthwhile doing something earlier in the day on the EMEA side
15:32:10 <samccann> are you up for hosting that? if you mean your morning?
15:32:13 <DonNaro[m]> yep
15:32:35 <samccann> ok we can chat later about how to update the  WG calendar etc but that sounds good to me
15:32:56 <DonNaro[m]> I think it could be really good
15:33:15 <samccann> so long as you can keep it to docs (aka words on virtual paper).  This meeting tends to get kinda deep into the DocOps stuff (doc tools... whatever ya wanna call it)
15:33:45 <samccann> #action Don Naro to create docs open office hrs on Thursdays for EMEA timezone
15:34:00 <DonNaro[m]> did we say Thursdays?
15:34:01 <samccann> there.. ya got an action item now!  Frame it on a wall :-)
15:34:26 <samccann> oh it can be a differenet day for sure. I don't think it matters much which day, only that it doesn't collide with any existing WG meetings if we can help it
15:34:49 <DonNaro[m]> winner, winner
15:36:17 <samccann> #topic Doc Tools
15:36:34 <samccann> do we have any updates here? Did you want to mention any new docsites you may or may not have spun up recently? :-)
15:37:56 <DonNaro[m]> yeah, I suppose. I've been wrangling with autoapi docs a little and finding out how much I have yet to learn about sphinx.
15:39:30 * DonNaro[m] finds link while cat wrangling
15:39:39 <DonNaro[m]> https://github.com/ansible/ansible-sdk/pull/40
15:40:29 <samccann> ooo what's the immaterial extension do?
15:40:45 <DonNaro[m]> trying to use the sphinx-ansible-theme with an immaterial extension that generates docs from docstrings in Python classes
15:41:33 <samccann> ooo neat!
15:41:33 <DonNaro[m]> Sviat has been very generous with his time and provided some guidance
15:42:14 <samccann> looking at the pr you replaced sphinxcontrib-api with sphinx-immaterail...
15:42:19 * samccann can't spell
15:43:03 <DonNaro[m]> yeah, so there are a few different commits in here...
15:43:46 <DonNaro[m]> https://github.com/ansible/ansible-sdk/pull/32/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698R17
15:43:46 <samccann> coolness
15:45:15 <DonNaro[m]> nitz added the immaterial extension in his commit as you can see. that does the automatic generation of API docs and makes things nice and easy.
15:45:27 <DonNaro[m]> but there are a few wrinkles
15:46:03 <DonNaro[m]> I mean, I don't mean to speak about anyone's work or anything
15:46:06 <samccann> yeah looking at the docsite and not seeing ...api docs.
15:46:10 <DonNaro[m]> or misrepresent here
15:46:34 <samccann> no worries. it's a work in progress etc
15:47:03 <DonNaro[m]> the immaterial ext does generate the API docs automatically but there are a few warnings
15:47:42 <DonNaro[m]> then there was a PR to switch to the ansible theme
15:48:36 <DonNaro[m]> I thought I had the API docs generating with the sphinx contribapidoc extension: https://github.com/ansible/ansible-sdk/pull/38/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698R19
15:49:32 <DonNaro[m]> but, as you can see from RTD, the API docs are empty
15:50:04 <DonNaro[m]> so still working on it and, yeah, basically sort of grafting the immaterial extension on to the ansible sphinx theme
15:50:28 <DonNaro[m]> the theme doesn't really matter
15:50:29 <samccann> cool stuff
15:52:29 <DonNaro[m]> anyway I'm sure it'll get going again after fest but if anyone reads this and wants to maybe take a look and suggest the best way to do auto API docs, please feel free
15:53:04 <DonNaro[m]> maybe that was a bit much? TL;DR is learning sphinx and breaking stuff.
15:53:04 <samccann> interesting work for sure
15:53:10 <samccann> LOL
15:53:24 <samccann> well it's helpful to post the details cuz there probably are folks around with ideas etc
15:53:31 <samccann> meanwhile whe should open the floor
15:53:32 <DonNaro[m]> there is also plenty of actual doc work in there
15:53:38 <samccann> #topic Open Floor
15:53:58 <samccann> Anyone have anything to bring up docs or doc tooling related? here's the time!
15:54:56 <DonNaro[m]> hi acozine ! 👋
15:54:58 <acozine> sorry to miss today, Fest is a bit distracting
15:55:15 <DonNaro[m]> hope you're enjoying Fest
15:55:16 <acozine> 👋Hi Don Naro
15:55:26 <samccann> yeah quiet day
15:55:35 <acozine> it's great, though I have not been around this many people in a long, long time
15:55:48 <acozine> so it's a little startling
15:56:01 <DonNaro[m]> I can imagine
15:56:12 <samccann> yeah. that takes some getting used to!
15:56:17 <samccann> meanwhile...
15:56:20 <samccann> #endmeeting