19:32:50 #startmeeting docs 19:32:50 Meeting started Wed Mar 8 19:32:50 2023 UTC. 19:32:50 This meeting is logged and archived in a public location. 19:32:50 The chair is darknao. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions. 19:32:50 Useful Commands: #action #agreed #halp #info #idea #link #topic. 19:32:50 The meeting name has been set to 'docs' 19:32:58 #topic Roll call 19:32:59 #chair pboy darknao pbokoc py0xc3[m] 19:32:59 Current chairs: darknao pbokoc pboy py0xc3[m] 19:33:03 .hi 19:33:04 darknao: darknao 'Francois Andrieu' 19:33:09 .hi mateusrodcosta 19:33:10 mateusrc: Sorry, but user 'mateusrc' does not exist 19:33:12 .hi 19:33:13 pboy: pboy 'Peter Boy' 19:33:35 .hello mateusrodcosta 19:33:36 mateusrc: mateusrodcosta 'Mateus Rodrigues Costa' 19:34:05 .hello hankuoffroad 19:34:05 hankuoffroad[m]: hankuoffroad 'None' 19:35:23 ok I think we can start 19:35:25 #topic Agenda 19:35:37 #link https://discussion.fedoraproject.org/t/docs-meeting-agenda-2023-03-08/79166 19:35:40 #info Announcements 19:35:42 #info Tickets review 19:35:43 #info Quick docs update 19:35:45 #info New fedoraproject.org website feedback 19:35:47 #info Everything about ui-bundle 19:35:49 #info Open Floor 19:35:51 #topic Announcements 19:36:17 #info Next milestone is F38 (2023-04-18) 19:36:20 #info F38 Beta Freeze is in effect until beta release next week (target: 2023-03-14) 19:36:21 #info We use GitLab to track work: https://gitlab.com/groups/fedora/docs/-/boards 19:36:33 anything else to add to that list? 19:36:59 nope 19:37:11 ok moving on 19:37:22 #topic Tickets review 19:37:33 we have one PR flagged for meeting 19:37:41 #link https://gitlab.com/fedora/docs/community-tools/documentation-contributors-guide/-/merge_requests/32 19:38:33 #link https://fedora.gitlab.io/-/docs/community-tools/documentation-contributors-guide/-/jobs/3877343281/artifacts/public/fedora-docs/contributing-docs/casual-contributions-pagure-pages.html 19:38:58 yes, I appreciate if you could take a look at it. 19:39:05 I did a quick review earlier, and I think it's very good 19:39:13 reading# 19:39:37 just one small nitpick 19:39:37 it is a new page 19:39:41 darknao: thanks 19:39:56 darknao: ok will fix 19:40:00 the Self-assign issue paragraph could be simpler I think 19:40:50 if you are a casual contributor, that mean you most likely don't have enough privileges to assign yourself the ticket, or even see the pencil icon to add tags 19:41:10 ah I didn't know that 19:41:51 I'm not sure. I think a FAS account is enough, isn'it? 19:42:07 so I think the 4 steps here can be removed and just keep the first sentence: if you want to take a ticket, just ask for it 19:42:13 You should be able to assign yourself, but no commit 19:42:31 I have a new account to test that. 19:43:03 pboy, I'm almost certain you need special access right on the repo to modify tickets 19:43:35 there is a "ticket" permission for that 19:43:53 or if you're maintainer or admin 19:44:00 OK. The advise wo write a comment is better anyway. 19:44:14 there is also an "allow anyone to edit metadata" setting. 19:44:30 darknao: sure I will redo that without committer privilege 19:44:44 glb: ah! good to know, let me check if that one is enabled here 19:45:15 glb: "Open metadata access to all" ? 19:45:22 I think, if we want to invite people to contribute, we should allow to take ticket. 19:45:35 if possible 19:45:38 I was going from memory. 🙂 19:46:26 well, I'm admin here so I can't really test this, but if hanku can check with his new account, that would be helpful 19:46:30 We have that set on the Fedora Magazine issue tracking repo 19:46:45 darknao: will do 19:47:01 the option is already enabled on the quick-doc repo, so that should work 19:47:24 very good 19:47:33 and in that case, please disregard my comment on your page :) 19:48:23 Overall Pagure UI keeps me focused 19:48:43 hankuoffroad[m] just a question: you don't describe the "edit a page" option, do you? 19:50:37 no. just keep to issue first. 19:50:52 OK 19:51:31 The page looks very good to me. 19:51:45 i mean issue/PR is a starting point to tackle priorities. navigating from edit tends to divert user to nitpicks 19:51:46 pboy: thanks 19:51:49 right so maybe you should rename that page then? 19:52:19 the current name implies this docs is for any pagure-based repo, but it's really focused on quick docs 19:52:22 that's a good idea. meaning the target of contributors? not really casual right? 19:53:22 I took an example of Quick Docs and the nature of QD, but in intro I empahsized it is used by other projects 19:53:51 hankuoffroad[m] I think it is informative for casual as for non-casual contributors to QD 19:54:10 s/as/as well as/ 19:55:06 I think we should specify in the title that it is for quick docs, but also keep the abstract that says the overall procees can be translated for any other Pagure project 19:55:08 darknao: yeah that could be precise. rename it to Contribution to Quick Doc repo - something like that..i'm open to your suggestion. 19:55:30 agreed 19:56:47 alright, anything else on this topic? 19:57:35 no 19:57:42 no 19:57:43 ok, next topic then 19:57:45 #topic Quick docs update 19:58:07 nothing from me at the moment, sorry 19:58:16 that's fine :) 19:58:35 I have to write the Quick Doc about sleep soon 19:58:50 Covering S0ix and S# sleep modes 19:58:54 s/S#/S3/ 19:59:03 darknao: i have cleared some PRs and issues duplicated/followed up in GItLab 19:59:32 I'm not sure what the flow is? Do I need to be given access to the Quick Docs repo the same way I was given to the DNf Guide one? 20:00:15 thanks hankuoffroad[m] 20:00:58 mateusrc: you should be able to open a PR on the Quick-Docs repo with your changes 20:01:10 mateusrc at least you should have the same permissions, I think (i.e. commit to repo). 20:02:00 Cool, thanks! 20:02:25 mateusrc Would be nice it you could "test" the QuickDoc guide and the template. And write down what you are missing. 20:03:01 Ok! 20:08:19 seems like nothing else for quick docs topic 20:08:26 #topic New fedoraproject.org website feedback 20:08:34 no, nothing from me 20:09:00 #link https://discussion.fedoraproject.org/t/fedora-workstation-front-page-revamp-first-cut-looking-for-feedback/37169/ 20:09:17 #link https://fedora.gitlab.io/websites-apps/fedora-websites/fedora-websites-3.0/ 20:10:03 Is it the same as 20:10:11 #link https://stg.fedoraproject.org 20:10:19 so current status is, there is one Documentation section in Contributors > Documentation, that are contributor focused docs 20:10:42 And will this be the future project landing page, which is currently redirected to getfedora? 20:11:00 and another one in Help > Documentation, that is user-focused doc (which is kind of empty right now, but we can add pretty much anything we want here) 20:11:05 pboy: no it's not 20:11:19 the one on gitlab is more up to date 20:11:28 the stg one is updated once weekly 20:11:55 OK, but it will be the future landing page? 20:11:55 and yes, this is going to be the future project landing page 20:12:11 https://fedoraproject.org 20:12:35 getfedora.org will disappear 20:12:45 Regarding documentation, i think that is not enough! 20:12:46 > the one on gitlab is more up to date 20:12:46 https://fedora.gitlab.io/websites-apps/fedora-websites/fedora-websites-3.0/ 20:15:03 The current solution is really bad. There is no docs at all. 20:15:05 > Regarding documentation, i think that is not enough! 20:15:05 An issue filed in the websites-3.0 repo with a list of titles, links, and descriptions would be great. 🙂 20:15:06 https://gitlab.com/fedora/websites-apps/fedora-websites/fedora-websites-3.0 20:15:28 I know. It's not finished. 20:15:35 #link https://gitlab.com/fedora/websites-apps/fedora-websites/fedora-websites-3.0/-/issues 20:15:47 And docs is quite different from help 20:16:05 Well, there are some docs under the contributors menu. But if you could also verify that those are correct, that'd be great. 20:16:23 pboy: do you have any proposals here? 20:16:59 darknao: The simplest one to make the same as for help for documentation. That would be the minimal. 20:17:28 The wide critique on Fedora is: technically excellent, missing docs, not usable.# 20:17:45 So we really need docs most visible! 20:18:26 ok, so just to summarize a bit about the docs situation on the website: 20:18:28 I thought the idea to put the links to docs directly on the download pages was a good one. 20:19:00 glb On a first look, the contributor docs is correct. But I'll check that in more detail. 20:19:11 Oh, yeah, btw I ahve a question for the Open Floor, soon... 20:19:29 we have the doc link directly in the front page, one dedicated section in the Help menu, another one contributors oriented in the Contributors menu, and various link in the download page 20:19:31 glb that is indeed a good one! And we should keep that! 20:19:42 like here: https://fedora.gitlab.io/websites-apps/fedora-websites/fedora-websites-3.0/workstation/download/ 20:20:41 relase notes and installation guide make sense and look good to me. 20:20:57 darknao yes, but we need the term "documentation", and we need it most visible! 20:21:09 s/relase/release/ 20:21:22 glb There is no installation guide anymore! 20:22:15 I personally think the Documentation in the Help menu is quite visible enough, but I'm also kinda biased as I'm on both team here 20:22:22 I think that is something that will need to be addressed right away then! 20:22:55 in any case, please open a ticket https://gitlab.com/fedora/websites-apps/fedora-websites/fedora-websites-3.0/-/issues here and we'll try to figure this out 20:23:17 (we need to move on to the two remaining topics) 20:23:47 OK let's switch 20:23:55 #topic Everything about ui-bundle 20:23:55 glb +1 20:24:09 ok so it seems you have some questions about the ui-bundle 20:24:14 please ask away :) 20:24:25 Well, The zu bundle is specified in site.yma in repo root. 20:24:32 in teampage and in quickdoc it is the same file name: 20:24:46 url: https://gitlab.com/fedora/docs/docs-website/ui-bundle/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable 20:24:52 What is it? Any link? 20:24:54 #link https://gitlab.com/fedora/docs/docs-website/ui-bundle 20:24:55 but: teamüage uses ./build.sh & ./preview.sh (which works for me on mac) 20:25:05 quickdocs uses ./builder.sh which doesn't work for me on mac 20:25:23 and they differ in handling the podman / dicker container 20:25:48 s/dicker/docker/ 20:25:52 the build.sh/preview.sh and builder.sh is unrelated to the ui-bundle 20:26:02 so I'm not sure to follow 20:26:04 And I'm wondering about that 20:26:39 the ui-bundle is a Antora thing that contains the styles & layout used to build the docs 20:26:54 basically, it's the website template 20:27:22 OK, and what does the preview building? 20:27:49 there is only two version of them: the stable one, used almost everywhere, and the staging one, used to test upcomming feature (there is none at this time) 20:29:25 So I can change the ui address and there is no change in the preview build process? 20:29:52 the process is the same yes 20:30:49 And what does the change in the build process between teampage and QuickDocs ? 20:30:56 you might end up with a different website look if you don't use the same bundle, but that should not affect the building process at all, just the resulting html files 20:32:27 I don't know, that should be the same process for any docs 20:32:32 I would like to have it the other way, update the look of the preview, but don't change the preview build process. 20:33:09 Well, the preview build process is definitely different between teampage and quickdocs 20:33:26 the script you mean? 20:33:35 Yes, the script. 20:33:49 you can use whatever version of the script with any repo 20:33:56 At least the result is different, temapage works for me, quickdoc does not 20:34:01 there is nothing specific in it 20:34:22 if the teampage script works for you, you can just use that for the quickdoc as well 20:34:49 OK, and where do I find the script? 20:35:03 in the teampage repo? 20:35:32 yes, but so far as I know the script is updated in the same step as we update the ui. 20:36:06 But it's OK for now. I'll look at the two repos. 20:36:23 And will come back, maybe with additional questions. :-) 20:37:03 There is a question from <+mateusrc> 20:37:07 I think only the new docsbuilder.sh script is auto-updating, the old one that work for you don't autoupdate 20:37:24 we are a bit out of time here :/ 20:37:31 pboy: Yes 20:37:33 Is it Open Floor already? 20:37:35 darkno OK, I'l give it a try. 20:37:46 Oh, well, but basically it was about RPM documentation 20:37:46 #topic open floor 20:37:53 mateusrc: you have 1 minute :p 20:38:08 we are already late 20:38:20 #nextmeeting 20:38:25 I read a blog post saying that RPM documentation in Fedora is lacking and it looks like what is there is intended for those who already know RPM 20:39:48 about using RPM or writing RPM? 20:40:07 Is zodbot out to lunch? 20:40:45 .nextmeeting 20:40:45 glb: (nextmeeting ) -- Return the next meeting scheduled for a particular channel. 20:41:05 I think that just me not using the right command 20:41:15 darknao: Writing 20:41:20 .nextmeeting fedora-meeting 20:41:22 glb: b'In #fedora-meeting is EPEL Steering Committee (starting in 18 minutes)' 20:41:25 glb: b'In #fedora-meeting is Magazine editorial board (starting in 19 hours)' 20:41:28 glb: b'In #fedora-meeting is F38 Beta Go/No-Go Meeting (starting in 20 hours)' 20:41:31 glb: - https://calendar.fedoraproject.org/location/fedora-meeting%40irc.libera.chat/ 20:41:49 We are 20:41:58 .nextmeeting #fedora-meeting-1 20:41:59 pboy: b'In #fedora-meeting-1 is FPgM office hours (starting in 18 minutes)' 20:42:03 pboy: b'In #fedora-meeting-1 is Rust SIG Meeting (starting in 18 minutes)' 20:42:06 pboy: b'In #fedora-meeting-1 is CPE PO Office Hours (starting in 18 hours)' 20:42:09 pboy: - https://calendar.fedoraproject.org/location/fedora-meeting-1%40irc.libera.chat/ 20:42:38 mateusrc: we have a small tutorial here: https://docs.fedoraproject.org/en-US/package-maintainers/Packaging_Tutorial_GNU_Hello/ 20:43:30 darknao: This is the blog post, there's a section with a rant on RPM: https://yorickpeterse.com/articles/switching-to-fedora-silverblue/ 20:43:49 The porblem might just be guiding the users better to the resources though 20:45:40 I guess, we should continue the RPM topic next meeting? It's late now. 20:45:42 yeah, the Packaging section of the docs is quite heavy https://docs.fedoraproject.org/en-US/packaging-guidelines/ 20:46:00 We won't make the next team nerveous 20:46:14 I think it really need some improvment, but that's unfortunately out of scope of our team 20:46:37 pboy: yes, let's continue the discussion on #fedora-docs if needed 20:46:46 thanks everyone for today! 20:46:48 #endmeeting