15:02:16 <samccann> #startmeeting Documentation Working Group aka DaWGs
15:02:16 <zodbot> Meeting started Tue Jul 18 15:02:16 2023 UTC.
15:02:16 <zodbot> This meeting is logged and archived in a public location.
15:02:16 <zodbot> The chair is samccann. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions.
15:02:16 <zodbot> Useful Commands: #action #agreed #halp #info #idea #link #topic.
15:02:16 <zodbot> The meeting name has been set to 'documentation_working_group_aka_dawgs'
15:02:24 <samccann> @room Meeting time! Who is here to talk the docs?
15:02:57 <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:04:39 <samccann> 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)
15:04:52 <samccann> 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!)
15:04:58 <samccann> official agenda at https://github.com/ansible/community/issues/678#issuecomment-1631365234
15:05:17 <samccann> hmm feeling kinda quiet here today... might be talkin to myself ;-)
15:05:21 <gotmax23> .hi
15:05:22 <zodbot> gotmax23: gotmax23 'Maxwell G' <maxwell@gtmx.me>
15:05:25 <samccann> woot!
15:05:38 <gotmax23> It looks like the meetbot is working, so that's a good sign
15:05:52 <samccann> cuz talkin to myself is fine, but when I start answering myself... might be signs of.. .trouble
15:06:23 <samccann> #chair gotmax23
15:06:23 <zodbot> Current chairs: gotmax23 samccann
15:06:24 <samccann> #topic Ansible 8.2.0 release
15:06:25 <samccann> #info we have a gotcha to work through where the autogenerated porting guide for Ansible 8.2.0 is't picking up the core porting guide content.
15:06:35 <samccann> proposal is we add the link manually for now. See https://github.com/ansible/ansible-documentation/pull/134/files#r1266801458
15:06:53 * samccann so glad I don't have my face in github
15:07:21 * gotmax23 still doesn't understand what exactly is incorrect in the porting guide
15:07:23 <samccann> gotmax23: - can you review/approve that PR change so I can merge and publish ps
15:08:13 <acozine> Sigh. Today we're having an outbreak of Bad Bots. Working on defensive measures.
15:08:14 <samccann> ok so my understanding (which could be off) - The Ansible porting guide automagically pulls in the related core porting guide.  Because the core porting guide now lives in ansible/ansible-documentation, the antsibull script can't find it so doesn't pull in anything
15:08:56 <samccann> at the least, what is there in the porting guide PR is wrong so I want to remove that one line and just link to the core porting guide for this release. Hopefully will all be fixed by next release
15:09:34 <samccann> #info the ansible porting guide pulls in the core porting guide but isn't doing it for this release since the core porting guide moved to the new docs repo. We can manually patch around that for today's release
15:09:49 <samccann> ooch.. bad bad bots acozine
15:11:15 <samccann> #info draft announcement for the release https://hackmd.io/rKWD9mXyRGKOEhHU-drX1g?both
15:12:45 <samccann> gotmax23: is that visible to you? and if so, can you review? I feel like the top section that tries to wordsmith around 'includes ansible-core' was not approved so I should revert it back.. see https://github.com/ansible-community/ansible-build-data/pull/258#discussion_r1245590416
15:12:56 <gotmax23> Ah, I see the problem now. The ansible-core entries were deleted...
15:13:54 <gotmax23> I can merge the ansible-build-data PR, because we need to have that now that's it's published to PyPI, but I'd like to wait on the ansible-documentation one
15:14:01 <gotmax23> Does that sound alright?
15:14:34 <samccann> We can wait a bit on the porting guide if you want. Not the first time we've had a release go out w/o the porting guide details published
15:14:58 <samccann> But do you think just adding a link to the core porting guide from the Ansible porting guide is 'good enuf' for now?
15:15:28 <samccann> I think Felix said on one of these channels he wouldn't be able to update the scripts to match the docs lift and shift for a few days.
15:16:12 <gotmax23> I can look at it later today and cut a release once I get some other work done
15:16:24 <samccann> ok cool
15:16:56 <samccann> I marked https://github.com/ansible-community/ansible-build-data/pull/269 ready for review
15:17:17 <samccann> Anwesha has lost her internet connection I think (or will soon) so we shouldn't wait for her if we can help it
15:18:20 * gotmax23 opens up the PR
15:19:01 <samccann> cool thanks!
15:19:32 <samccann> I'll stop typing both here and in the community WG channel and just keep the releaes conversation over there since there are a couple of people looking at things there
15:19:43 <samccann> and might save gotmax's eyes from bouncing channels :-)
15:20:06 <samccann> #topic documentation updates
15:20:41 <samccann> #info EE getting started guide published to devel and work continuing on it
15:21:17 <samccann> #info awx operator work has a batch of PRs but each needs a rebase before/after a merge cuz they all touch the same area.
15:22:05 <samccann> I'm also working on another issue that we hope to get community writers help with. This is to create a scenario guide out of the automation_hub_collection.
15:22:34 <samccann> Tho it has a RH name, it works with galaxy as well so worth adding to the galaxyNG guide.
15:23:28 <samccann> #info proposed new scenario guide structure - https://github.com/ansible-community/community-team/issues/310
15:23:52 <samccann> So if anyone is interested, let us know!  It should be 4-6 separate files so we can work in parallel
15:24:27 <samccann> And the collection owner is aware we will just guess at the examples etc. They will have to correct them
15:25:25 <samccann> hmm... don is out for another week or so, so we're light today on docs topics
15:25:31 <samccann> #topic Open Floor
15:25:41 <samccann> Anyone else have something to bring up related to docs?
15:26:01 * gotmax23 is back
15:26:09 <samccann> welcome back :-)
15:27:29 <gotmax23> I created tags in the ansible-documentation repository as discussed in https://github.com/ansible/ansible-documentation/issues/66
15:27:29 <samccann> We're light on topics today...anything else anyone wants to bring up before we end meeting? we've got time...
15:28:02 <gotmax23> Should we discuss Set labelling strategy #101 ?
15:28:19 <gotmax23> #link https://github.com/ansible/ansible-documentation/issues/101
15:28:45 <samccann> #chair
15:28:45 <zodbot> Current chairs: gotmax23 samccann
15:28:59 <samccann> huh.. thought that would give me a list.
15:29:18 <samccann> ok there it is.. yeah we can chat a bit on labelling but it's just you and me here so we can't finalize anything
15:29:32 <samccann> #topic labelling strategy in new docs repo
15:30:05 <samccann> #info we have backport labels now that will automatically create backports to each stable branch, if labeled.
15:30:53 <samccann> #info other proposed label - triage for new issues and PRs so we can ensure someone does an initial review of incoming items
15:31:02 <gotmax23> Yeah, I think those have been working well
15:31:55 <samccann> cool cool
15:32:41 <samccann> I mentioned a 'needs_info' label. The way that worked in ansible/ansible is that a bot would see it and ping the OP..erm.. once or twice a month for a time and if we got no response, would auto-close the issue
15:32:44 <samccann> (or PR)
15:32:48 <Landrash[m]> New labeling startegy seems like a good plan
15:33:01 <samccann> Thanks Landrash and welcome!
15:33:08 <samccann> #chair Landrash
15:33:08 <zodbot> Current chairs: Landrash gotmax23 samccann
15:33:12 <gotmax23> Yeah, I think needs_info is a good idea
15:33:43 <gotmax23> I can add that to the triage script I wrote in a follow up PR
15:33:56 <samccann> cool thanks
15:34:03 <Landrash[m]> A suggestion would be that it's included in the issue template that issues without response will be auto-close or a link to the how issues are handled
15:34:36 <gotmax23> The other proposed triage-related thing was an autoresponder to welcome contributors similar to what we had in ansible-docs
15:34:41 <Landrash[m]> Could be in docs for how to contribute or similar
15:34:52 * gotmax23 goes ahead and adds links to the meeting minutes
15:34:55 <gotmax23> #link https://github.com/ansible/ansible-documentation/pull/118
15:34:57 <gotmax23> is the PR
15:35:10 <gotmax23> #link https://github.com/ansible/ansible-documentation/issues/69
15:35:19 <gotmax23> is the autoresponder proposa
15:35:20 <samccann> hmm... well the way the needs_info worked on ansible/ansible is that it would comment and mention in the comment that it would auto-close I think. So feels like that would be a better place imo vs in the issue template itself
15:35:45 <samccann> thanks gotmax23 !
15:36:22 <samccann> are there other labels folks are used to in other repos that we should consider?
15:36:24 <gotmax23> I think adding it to some CONTRIBUTING doc as Landrash said is a good idea so contributors know what to expect
15:36:52 <gotmax23> I think needs_triage, needs_info, and sc_approval is a good start
15:37:33 <gotmax23> We might also want to consider some sort of issue template
15:38:46 <samccann> just created an issue for... an issue template :-) - https://github.com/ansible/ansible-documentation/issues/135
15:39:48 <gotmax23> FWIW, I prefer the classic issue templates rather than those form things
15:40:22 <dansou901[m]> Any additional thoughts on https://github.com/ansible-community/community-topics/issues/253?
15:40:49 <samccann> created an issue for a CONTRIBUTING file.. thanks Landrash
15:41:03 <samccann> welcome  dansou901 !
15:41:09 <samccann> #chair dansou901
15:41:09 <zodbot> Current chairs: Landrash dansou901 gotmax23 samccann
15:41:20 <samccann> #link https://github.com/ansible-community/community-topics/issues/253
15:41:54 <samccann> Do you have an example of your deeply nested module so we can review?
15:42:10 <samccann> I'm reluctant to change alphabetical ordering because it's... consistent so to speak
15:42:23 <dansou901[m]> not right now, but I can add it tomorrow
15:42:37 <dansou901[m]> or later
15:42:47 <samccann> so this is the example I always go back to - https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_bgp_neighbor_address_family_module.html
15:42:59 <samccann> there may be others with deeper nesting
15:43:35 <dansou901[m]> mine is not as badly nested as that one, but the problem is the same
15:44:12 <samccann> hhjmmm I wonder what this one's argspec looks like
15:44:23 <samccann> or if you can point to your argspec if it's available?
15:45:32 <dansou901[m]> it's on our internal network which I need to access at least via VPN, can't go there right now
15:46:25 <gotmax23> Okay, I think I got the porting guide to work
15:47:09 <dansou901[m]> Also, the example you posted is a module and not a role, modules don't have arg_specs if I recall correctly
15:48:04 <samccann> modules do have argspecs yeah, but sorry, missed that your topic was talking about roles
15:48:21 <samccann> gotmax23: cool thanks!
15:48:41 <samccann> this is the argspec for the module - https://github.com/ansible-collections/cisco.nxos/blob/main/plugins/module_utils/network/nxos/argspec/bgp_neighbor_address_family/bgp_neighbor_address_family.py
15:48:50 <samccann> if anyone was interested
15:51:18 <samccann> dansou901: looks like your topic does have some support from others. I added it to tomorrows Community WG meeting
15:51:33 <samccann> I don't know if you can make that, tho you don't have to be there for it to be discussed
15:51:57 <samccann> it happens at 2pm ET on https://matrix.to/#/#community:ansible.com
15:52:39 * dansou901[m] sent a yaml code block: https://libera.ems.host/_matrix/media/v3/download/libera.chat/af0ccc0d4b65da572f9b561fe6b47072174fa0d1
15:53:09 <dansou901[m]> s/```yaml//
15:53:52 <dansou901[m]> something like this
15:54:41 <dansou901[m]> s/```yaml//
15:54:53 <samccann> ok thanks
15:54:56 <samccann> that helps
15:55:32 <samccann> it's likely the community WG folks who will make the final decision on that topic but as I said, looks like there is growing support for the idea
15:56:40 <dansou901[m]> I can attend that meeting tomorrow
15:56:59 <samccann> Cool thanks!
15:57:09 <samccann> anything else on docs anyone wants to bring up before we end the meeting?
15:58:05 <gotmax23> Nothing from me
15:58:11 <samccann> cool thanks everyone!
15:58:15 <samccann> #endmeeting