19:30:35 #startmeeting docs 19:30:35 Meeting started Wed Nov 23 19:30:35 2022 UTC. 19:30:35 This meeting is logged and archived in a public location. 19:30:35 The chair is darknao. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions. 19:30:35 Useful Commands: #action #agreed #halp #info #idea #link #topic. 19:30:35 The meeting name has been set to 'docs' 19:30:42 #topic Roll call 19:30:50 .hi 19:30:50 pboy: pboy 'Peter Boy' 19:30:54 #chair pboy darknao pbokoc py0xc3[m] 19:30:54 Current chairs: darknao pbokoc pboy py0xc3[m] 19:30:57 hi 19:31:00 .hi 19:31:00 AnthonyMcGlone[m: Error: Missing "]". You may want to quote your arguments with double quotes in order to prevent extra brackets from being evaluated as nested commands. 19:31:00 Hello... is this the docs meeting? 19:31:11 AlanBowman[m]: yes, it is! 19:31:22 .hello hankuoffroad 19:31:23 hankuoffroad[m]: hankuoffroad 'None' 19:32:03 Cool. I've been looking at some of the docs stuff for Fedora and wanted to see if I could contribute. 19:32:59 AlanBowman[m]. Good idea! 19:33:08 and welcome :) 19:33:37 Thanks.. 19:35:01 ok, I think we can start 19:35:06 #topic Agenda 19:35:12 #link https://discussion.fedoraproject.org/t/docs-meeting-agenda-2022-11-23/44290 19:35:14 #info Announcements 19:35:16 #info Action item followup 19:35:18 #info Open tickets review 19:35:20 #info Open Floor 19:35:23 #topic Announcements 19:35:29 #info New variant-oriented homepage is live 19:35:31 #info New Workstation docs has been shipped 19:35:33 #link https://docs.fedoraproject.org/en-US/workstation-docs/ 19:35:35 #info Next milestone is F38 (2023-04-18) 19:35:37 #info We use GitLab to track work: https://gitlab.com/groups/fedora/docs/-/boards 19:35:59 any other announcement to share? 19:37:02 ok, moving on then 19:37:08 #topic Previous action items 19:37:20 #info pboy was to test run the new builder script on Mac 19:37:43 oohje 19:37:47 still on todo 19:38:13 #action pboy to test run the new builder script on Mac 19:38:24 #info darknao was to deploy WIP workstartion-docs on staging 19:38:39 that is done, and even live on prod 19:38:53 #info darknao was to set up Vale linting on contributors-guide and Fedora Linux homepage repositories 19:39:10 not started yet 19:39:22 #action darknao to set up Vale linting on contributors-guide and Fedora Linux homepage repositories 19:39:29 #info darknao was to remove old docs from the website 19:39:58 that is in progress, see PR: https://pagure.io/fedora-infra/ansible/pull-request/1257 19:40:32 next topic 19:40:36 #topic Open tickets review 19:40:45 So we have one ticket to discuss 19:41:00 #link https://gitlab.com/fedora/docs/fedora-linux-documentation/release-docs-home/-/issues/4 19:41:26 Now that the install guide is gone, we have a few places that needs to be updated to point somewhere else 19:41:56 for instance: https://spins.fedoraproject.org/kde/download/index.html 19:42:02 What about the suggestion to redirect those links to 19:42:02 https://docs.fedoraproject.org/en-US/fedora/latest/getting-started/ 19:42:20 there are links to every installation guide 19:43:36 yeah I guess that would work 19:43:59 It saves us to comb all the docs 19:45:07 ok, anyone interrested to implement that? 19:45:39 that is quite easy, docs is here: https://docs.antora.org/antora/latest/page/page-aliases/ 19:45:56 Well, I can try, but you are the most technically experienced. I did that with server, but didn't check success 19:46:53 it's a good oportunity to learn :) 19:47:06 OK, I'm willing to learn. :-) 19:47:20 cool :) 19:47:56 How many pages are impacted? Maybe I can split the work with pboy as a way to learn some of how the project works. 19:47:57 #action pboy to create a redirect for old install-guide links 19:48:21 AlanBowman[m] it's only one page. 19:48:39 OK. it's all you then. 19:49:19 well, actually, there is maybe more than just one page 19:49:50 hm, I think i add it to the getting started page? 19:50:22 At least, that's how I understand the doc 19:50:31 we have various websites (alt.fedoraproject.org, spins.fedoraproject.org, and getfedora.org basically) and they all have some kind of links somewhere redirecting to the install-guide or a subpage of that 19:51:26 for instance, this second link: https://spins.fedoraproject.org/verify.html 19:51:47 at the bottom, the documentation link point to https://docs.fedoraproject.org/en-US/fedora/latest/install-guide/install/Preparing_for_Installation/#sect-verifying-images 19:52:14 The alt.fedoraproject page has a link to the Install Guide in the footer that gives a 404 19:52:15 that one doesn't exist either, so we need to either redirect it, or update the link on the website 19:52:42 OK, so I habe to add several aliases to the getting started page? 19:53:06 I think we should first do some kind of inventories of broken links on various websites (spins, alt & getfedora) 19:53:25 then apply the redirect for those pages 19:54:00 or modify the websites, whatever is the easiest 19:54:12 OK, so we habe to comb all our sites? 19:54:25 habe -> have 19:54:40 yeah pretty much 19:54:45 I can do that 19:54:51 should be easy 19:55:29 darknao +1 19:55:43 #action darknao to list broken docs links in websites 19:56:33 ok I think that's all for the tickets 19:56:52 I have something for future tickets 19:57:01 sure, go ahead 19:57:50 Next milestone, F38, FESCO agreed to the proposal to generate the release notes from the change proposals. 19:58:08 nice 19:58:13 So we should make a plan about the details to accomplish that 19:59:54 ok, what kind of plan do we need for that? Are we just going to do some simple copy/pasta from the change proposal to release notes pages? 20:01:04 The idea was to do it automatically. To comb the change proposals for title, description, and release note 20:01:31 and put it into one file or several partiols to generate the release note from. 20:02:10 So, at minimum we have a title and a description for every change. 20:02:24 And not a black hole 20:02:35 on an unknown amount of changes 20:02:47 so the idea is to get someone to write a script of some kind to do all that, right? 20:02:57 Where are the change proposals located? Would it be possible to view it? 20:03:03 Yeah :-) 20:03:34 The change proposals are a set of wiki pages. 20:04:01 And there are already some scripts to extract information from it. 20:04:09 pboy: would you be able to create a ticket on our main repo to explain the need? i think it deserves more work than just a action line here :) 20:04:28 Yes, I can do it. 20:04:34 great thanks! 20:05:00 AnthonyMcGlone[m] do you have some experiences with scripting? 20:05:32 I have written scripts in Python before, yes. 20:05:56 Look at https://fedoraproject.org/wiki/Changes, there various examples 20:06:16 btw, the main documentation repo is https://gitlab.com/fedora/docs/docs-website/docs-fp-o/-/issues 20:07:39 we should use that one (just like on Pagure before) when we have an issue that is not specific to any other repository (general documentation website issues) 20:08:17 basically, when you don't know where to open a ticket, use that one :) 20:09:00 I think AnthonyMcGlone[m] was looking for examples of Change proposals. 20:09:19 Looking at the wiki page, they all have a Release Notes tracker entry. 20:09:39 There is probably a search filter to pull all those in to one location. 20:09:48 pboy: yes, that was more about my last comment about creating a ticket in our main repo :) 20:09:51 Jira does this, for example. 20:10:19 darknao, OK, I'l use it. 20:11:11 I'm wondering about the "pricing" tab at the top. Do I have to pay for an issue? 20:11:35 AlanBowman[m]: Release notes are tracked on pagure, and there is indeed a filtering option, like this: https://pagure.io/fedora-docs/release-notes/issues?status=Open&milestone=F38&close_status= 20:14:23 there is also a special category on the wiki for each version: https://fedoraproject.org/wiki/Category:ChangeAcceptedF38 20:16:32 I've yet another item, when we are finished with the release notes. 20:17:21 That might be what was meant by doing the release notes automatically. The release notes for some software I've used were just a link to an automatically generated page with a list of what was added/worked on/fixed. 20:17:34 I think we are a bit off topic anyway, so let's move to the open floor for the remaining of the meeting 20:17:42 #topic Open Floor 20:18:21 OK, my wish: We need a working plan for the next months and a plan who will do what. 20:18:42 resp. who is planning to do what. 20:19:31 I was personnally going to work on the docs website revamp 20:20:09 but that's not happening anytime soon, as I'm also working on the actual fedora websites revamp too 20:20:26 so most likely after f38 20:21:09 note that I may start before that, but it's not going to be ready before f38 anyway 20:22:04 I think we several open issues: our team page, the release notes project, the quick docs, the tools set, a replacement for the old administration guide, just to name a few. 20:22:54 And some design or UX items, e.g.. a mor visible identification of the update status of our docs pages. 20:22:54 I also think we should use gitlab tickets more 20:23:31 we have a fews things on our plate as you explain, and most of them are just topics on discussion.fp-o 20:23:59 I saw the Quick Docs thread over on the discussion fedoraproject org site. I can help out with that (or some of the other priority items mentioned). 20:24:03 darknao agreed. Maybe we should discuss out ideas on discussion and the generate tickets for each (sub)project 20:24:09 using tickets more will probably help new contributors to know where they can help 20:25:00 We should try to find out, who wants to do what. 20:25:09 and to coordinate it 20:25:22 darknao: tickets mean issue boards? 20:25:31 hankuoffroad[m]: yes 20:26:00 and probably we have to search for someone for a specific tasks 20:26:39 We are running out of time. I'll open a thread about this on discussion. 20:28:37 ok thanks everyone 20:28:49 I agree about creating tickets as well. It's great for defining tasks with a set of acceptance criteria. 20:30:01 Yes, tickets have the advantage that you can find them again, unlike discussion. 20:31:28 #endmeeting