15:00:37 <samccann> #startmeeting Documentation Working Group aka DaWGs
15:00:37 <zodbot> Meeting started Tue Jun 21 15:00:37 2022 UTC.
15:00:37 <zodbot> This meeting is logged and archived in a public location.
15:00:37 <zodbot> The chair is samccann. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions.
15:00:37 <zodbot> Useful Commands: #action #agreed #halp #info #idea #link #topic.
15:00:37 <zodbot> The meeting name has been set to 'documentation_working_group_aka_dawgs'
15:00:42 <orandon[m]> DaWGs unite
15:00:48 <samccann> #topic opening chatter
15:00:50 <samccann> WOOF!
15:00:58 <samccann> @room Meeting time! Who is here to talk the docs?
15:01:20 <orandon[m]> o/ I'm double booked (again) but I'm around
15:02:01 <samccann> #chair Don Naro
15:02:01 <zodbot> Current chairs: Don Naro samccann
15:02:18 <samccann> Anyone else around? briantist felixfontein ?
15:03:09 <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:03:26 <samccann> Official agenda is at https://github.com/ansible/community/issues/643#issuecomment-1155397839
15:04:34 <briantist> o/
15:04:59 <samccann> #chair briantist
15:04:59 <zodbot> Current chairs: Don Naro briantist samccann
15:05:06 <samccann> #topic Documentation updates
15:05:17 <samccann> #info Work beginning on revamping the user guide. See https://github.com/ansible/ansible/issues/78082#issuecomment-1159185553 for details on how we'll proceed.
15:06:03 <samccann> So Don Naro is on a roll and tackling the user guide next. That ^^ shows in general what we hope to implement. Gist of it is, pull out sections into their own guides so they are easier to find. It's a bit of a behemouth right now
15:08:38 <orandon[m]> and just to throw it out there. part of the motivation here is to tackle point 3 in https://github.com/ansible-community/community-topics/issues/81
15:08:51 <orandon[m]> "Improve findability and readability of our top guides and pages (user guide, Install guide, community guides)."
15:08:51 <samccann> yes indeedy!
15:12:08 <samccann> yep. So as part of this, we'll also be getting bolder (for us) in our redirects. In the past, we've stuck with existing URLs as much as possible, but  that also impacts/limited our ability to restructure the way it all needs.  So..ahem.. gloves are off in this Ansible 2.14/7 devel time to move things around to make it more coherent and findable etc.
15:12:28 <samccann> With the goal that it 'goes live' on latest when 2.14 and 7 release at around the end of the year.
15:16:03 <samccann> The one drawback is that it will be hard to do backports of other user guide PRs to latest during this time.  Now we haven't been doing regular backports for docs before, so this isn't a big change
15:16:07 <felixfontein> sorry, I'm not really around today (again :( )
15:16:27 <samccann> ok felixfontein thanks for letting us know.
15:17:08 <samccann> So a critical change to the userguide that has to go into latest might have to be manually fixed in stable-2.13 vs a direct backport. just fyi.
15:18:25 <samccann> #info Ansible 6 will release today. Will take a bit to get docs in place and published to match but should happen today or tomorrow latest.
15:19:15 <samccann> there are a batch of PRs that can't merge until the release happens, and then it's quick backports to get them into /latest/ so we can publish. Short burst of busy times but it should get out today depending on when the package actually releases.
15:20:55 <samccann> #info WriteTheDocs NG hosted a session on Friday for Open Source docs and Ansible!
15:20:55 <samccann> Amara:  I don't know if you are around to give a quick update on how that event went? or anyone else who attended?
15:21:46 <samccann> ok might not be around. As I understand it, it was well attended.
15:22:40 <samccann> Write The Docs is an organization of people dedicated to quality documentation, with a strong overlap with open source people so a great venue. gundalow and cybette presented to  the group on a twitter space.
15:23:49 <samccann> #info - if you need an editor to review docs PRs or do light editing (edit on github) we have a team of community writers willing to help. See https://github.com/orgs/ansible-community/projects/3/views/1?sortedBy%5Bdirection%5D=asc&sortedBy%5BcolumnId%5D=Status and ping us here if you need access to add your PRs/easyfix issues to that board.
15:24:55 <samccann> #topic doctools
15:25:15 <samccann> #info - we have canonical URL in Ansible 2.3 working as a PR. Will work to get it merged this week.
15:25:15 <samccann> That's the first part of trying to move google traffic off ancient docs.
15:25:49 <samccann> PRs for that old a branch require a lot of approval but I hope to get that merged after the Ansible 6 release (which requires a lot of PR backports to get approval as well :-)
15:26:32 <samccann> #info Looking for ideas on how to get CI testing to work on rst pages excluded from ansible-core (what ansible/ansible CI covers today) - Please comment on https://github.com/ansible-community/community-topics/issues/111
15:27:27 <samccann> We started that discussion I think last week and I moved the comments into that issue. TL;DR; - we have a growing batch of RST files in ansible/ansible that no longer go through CI testing based on how we split core docs from Ansible package docs.
15:27:47 <samccann> But it also touches a bit on overall collection-level docs testing, which is also not part of ansible/ansible CI.  So a few things to address there.
15:28:38 <samccann> and for the curious - we went from zero docs build warnings to 1100+ since the collection split two years ago. So it's definitely something we want to address.
15:31:02 <samccann> #topic Open Floor
15:31:14 <samccann> ok there's the time where you can bring up whatever is on your mind wrt docs.
15:31:50 <samccann> got a pr or issue on your mind? or some other feedback or ideas for docs? here's your chance
15:35:33 <samccann> ok thinking it's time to close out this meeting. A quick one this week!
15:35:46 <samccann> #endmeeting