14:31:19 #startmeeting DaWGs aka Docs Working Group 14:31:19 Meeting started Tue Feb 25 14:31:19 2020 UTC. 14:31:19 This meeting is logged and archived in a public location. 14:31:19 The chair is acozine. Information about MeetBot at http://wiki.debian.org/MeetBot. 14:31:19 Useful Commands: #action #agreed #halp #info #idea #link #topic. 14:31:19 The meeting name has been set to 'dawgs_aka_docs_working_group' 14:31:33 who's around? 14:32:06 me! 14:32:19 #chair samccann 14:32:19 Current chairs: acozine samccann 14:32:22 cbudz has a meeting conflict today 14:32:31 bummer! 14:33:02 2020 Agenda for this meeting is: https://github.com/ansible/community/issues/521 14:33:22 * gundalow is here for 10 minutes or so 14:33:26 #chair gundalow 14:33:26 Current chairs: acozine gundalow samccann 14:33:40 gundalow: you get to be furniture, even for ten minutes 14:33:45 today's agenda is https://github.com/ansible/community/issues/521#issuecomment-587532379 14:33:48 woot 14:33:56 plus https://github.com/ansible/community/issues/521#issuecomment-590491250 14:34:33 plus, any topics that are not listed there can be raised during the Open Floor 14:35:12 I think I'll reorder the list, leaving status updates for closer to the end 14:35:18 wanna start with the contributor summit since gundalow is here? 14:35:24 good idea 14:35:33 #topic contributor summit Europe 14:35:59 #info details at https://github.com/ansible/community/issues/521#issuecomment-590491250 14:36:25 #info The next Ansible Contributors Summit is Sunday, 29th March. And we will have a hackathon on BOTH the Monday & Tuesday. in Gothenburg, Sweden 14:36:42 #info Contributors Summit and hackathon will be available online as well 14:36:46 gundalow: will core be unfrozen by then? 14:37:00 or will the hackathon focus on collections? 14:38:14 acozine: good question. Given current data, Devel should be unfrozen and collections should be up and running. 14:38:29 I expect a lot to be getting started with Collections 14:38:53 it seems like a good time to be getting the community together 14:39:00 Yup :) 14:39:27 * gundalow stands up and exits stage right 14:39:33 pursued by a bear? 14:39:37 heh 14:39:41 (sorry, couldn't resist) 14:39:50 * acozine waves at gundalow 14:40:19 all right, any questions about the Contributors Summit? 14:40:30 ideas, suggestions, comments? 14:40:45 it's very quiet today 14:41:24 that it is 14:41:50 sssh! 14:42:07 heh 14:42:10 #chair bcoca 14:42:10 Current chairs: acozine bcoca gundalow samccann 14:42:16 toss furniture... 14:42:37 #topic ansible freeze dates 14:42:59 #info - details on Ansible freeze and collections - https://github.com/ansible-collections/overview 14:44:08 we expect the `devel` branch to freeze NEXT WEEK 14:44:37 #info 'devel' branch freezes March 2nd 14:45:05 so if you have changes you want to go in before then, now is the time! 14:45:10 seize the moment! 14:45:14 carpe diem! 14:45:18 carpe the docs! 14:45:21 heh 14:45:31 and ping us here for reviews, etc. 14:46:23 speaking of which... as we all know (heh) most of the modules will be migrated from ansible/ansible to collections. 14:46:51 There is a ..erm.. temp repo called ansible-base that gives an indication of what this will be. 14:47:11 #topic Doc review for ansible-base 14:47:41 #info looking for community help to verify the docs are looking good for the ansible world w/o modules 14:47:55 #link http://docs.testing.ansible.com/ansible/devel/index.html 14:48:17 That's basically make webdocs off that temporary ansible-base repo. 14:48:28 please poke around and let us know if you find any problems/issues etc 14:49:31 #info this test docsite doesn't include collections modules yet. That's coming, as is a 'moved to' stub for existing modules in 2.9 to say where they moved to 14:49:49 there are errors from the porting guides 14:50:06 oh, we do have the collections stuff up there, on a different branch 14:50:26 yes, all those links we carefully put in for modules mentioned in the porting guides no longer work. TBD what we'll do about all them 14:50:44 i'm thinking hard-links (aka urls) but there's a further problem 14:51:28 in that the 2.10 porting guide already has quite abit of links, and all those would go to a collection somewheres...and what does a 'porting guide' mean after 2.10? (aka when collections are revving independently) 14:51:50 hmm, won't those errors go away once we integrate the collections build? 14:51:59 the porting guide links will go to the stub pages then, right? 14:52:17 oh good point! yes the older porting guides should still work! doh! 14:52:18 (this only fixes the 2.9-and-older porting guides) 14:52:40 i'm not doing the whole split-brain well between the collections pipeline work and the ansible-base work :-P 14:52:44 we do still have some sample stub pages on the testing site 14:52:48 see http://docs.testing.ansible.com/ansible/2.10/modules/gcp_compute_firewall_info_module.html for example 14:53:06 please remember that the testing site is subject to change without notice 14:53:11 #info sample stub page for when modules migrate to a collection http://docs.testing.ansible.com/ansible/2.10/modules/gcp_compute_firewall_info_module.html 14:54:50 I believe the changelog fragments are moving with the modules they reference into collections 14:55:29 erm... 14:55:29 so perhaps that's the future of porting guides 14:55:45 there's two problems with that off the top of my head - 14:56:00 1 - they are in rst and galaxy land only deals with md 14:56:14 2 - nothing references the change logs in galaxy land. 14:56:47 true, we would either have to expand the collections docs pipeline to pull in changelog fragments, or create a new utility 14:56:49 I suppose we could solve them with the readme.md having a link to the changelog, but then there needs to be something that will recreate a changelog.rst from all those fragments within a collection 14:57:44 I think it woudl be great to have a utility where you provide a list of FQCNs and versions, and the utility spits out an integrated HTML page that shows you all the changes that apply 14:57:48 well I agree they should move with the collection. I just think we have some Deep Thoughts to think through on how we recreate the changelog file for each collection, and how it handles multiple versions etc. But yep, that is likely the porting guide stopgap future 14:57:57 that would probably have to run locally 14:58:30 ^^^ by "that", I mean the pie-in-the-sky collections-diff utility I half-described above 14:58:32 #action need to discuss how changelog fragments work within a collection and how to get versions of changelog files visible to a collection user 14:58:57 #info we think change log fragments are being migrated along with the modules... need to verify that 14:59:12 bcoca you still lurking?? ^^ 15:00:37 no, migration is doing nothing with changelogs 15:00:51 i believe RMs are looking into that with community 15:01:00 I saw some chatter about it recently 15:01:02 yesterday, maybe? 15:01:08 anyone know how to remove an info in irc :-) 15:01:12 heh 15:01:25 you put "need to verify", I think it's fine 15:01:26 migration is not even keeping git hisstory, so changelogs would not be a feasable part of it 15:02:52 ok so we'll have changelog fragments and thus a changelog.rst for 2.10, but TBD what happens after that 15:03:36 each repo will have to handle that 15:03:46 so we need to figure out what happens post 2.10 so that something is in place to handle changelog equivalents and/or porting guide equivalents per repo/collection 15:04:42 #info changelog fragments not migrating. So 2.10 will have a porting guide and changelog.rst but TBD what happens in the future. Will be up to each repo to maintain 'something' to handle versioned based information. 15:04:45 you will probably get something uniform from community, but for 3rd parties .. that is going to be 'fun' 15:04:46 that could be a great topic for the hackathon at the Contributors Summit! 15:05:02 or just make it a requirement 'do same as community if you want to see docs for your stuff on our site' 15:05:32 yep, I think we work as a community to figure out that. And anyone else is welcome to do the same or roll their own with their own docsite 15:06:15 #action propose a discussion topic on changelogs/porting guides in the collections world to the contributors summit. 15:08:14 any other questions, comments, suggestions, complaints, ideas, or any other reactions on the topic of freeze dates? 15:08:26 aka the Great Module Migration? 15:08:42 herds of modules.. .trotting in the wild... 15:09:13 i would say 'content', cause though modules are the bulk, what is really going to be a pain is the other plugin types 15:09:25 ah, okay 15:09:43 aka the Great Content Migration? 15:09:55 The plugin exodus! 15:10:02 oh, I like that better 15:10:51 Content is ambiguous in that phrase - could be a noun meaning "stuff" and could be an adjective meaning "satisfied" 15:11:11 but the Great Plugin Exodus is clear, concise, and kind of funny 15:12:05 #topic status updates 15:12:41 samccann and I have been reviewing, merging, and/or closing as many docs PRs as we are able 15:12:52 current count is under 70 15:13:32 we've also been working with the localization team on Japanese translations of a few pages of the docs 15:14:40 and testing out the new collections docs pipeline 15:16:10 it would be great to triage the docs issues this week 15:16:31 if anyone out there in ansible-docs land has time, please take a look 15:16:43 and please put a note here in the chat so we know to follow up 15:17:16 We will need to figure out what remains after the plugin exodus 15:19:09 yes, there will be a lot of cleanup after the Plugin Exodus 15:20:13 okay, we have ten minutes remaining 15:20:17 #topic open floor 15:20:51 contributors, lurkers, this is your chance! 15:21:28 if you have a question, a complaint, a comment, an issue you filed that you'd like to push to the top of the pile, a PR you created that you'd like reviewed 15:21:33 now is the time 15:22:06 let us know, and we will find answers, take note of problems, look at issues, review PRs 15:22:41 everyone is encouraged to join the conversation 15:26:05 five minutes left 15:26:19 if nobody has a topic to bring to the floor, we'll end early 15:27:49 thanks everyone! 15:27:53 #endmeeting