 Hi everyone and welcome to the Federa Chorus Docs Hax Fest. So I should be presenting with Jonathan LeBone. But he has some issues, so I will start and I'll let him try to work out his issues and he will join us soon. But we don't need much to present. So that will be fine. So welcome everyone. The goal here today is to work on docs for Federa Chorus. So hopefully you have a basic idea of what Federa Chorus is. If you don't, that's fine. You can check out the links, you can check out the website. And I've posted in the chat a hackMD link, which is a convenient way to share information. And you should also see the hackMD on the screen. So the general idea is that we want to improve the Federa Chorus docs during this Hax Fest. And so the easiest way to do it is to do it together at the same time. And hopefully we'll be here. And there are a lot of Chorus folks here, I think, to help both with questions and with review, PRs and everything. So feel free to ask questions either in the chat or in the ISE channel for Federa Chorus. So I don't remember if we put it here. Hmm. We did not put links here. Maybe we should have some links. Can I add a link? Do you want me to put in? Great. The ISE channel maybe. So yeah, feel free to ask questions. Of course, we're here to help too. There will be just a notice, there will be a second Federa, there are multiple Federa Chorus presentations during NEST, but there will be another session on Sunday, which is more like a workshop for getting started with Federa Chorus. And so and this is on Sunday, Sunday morning. All right, so let's get started. The the idea here is so the source. I cannot point on my screen, but maybe I can highlight. So the sources are here for the Federa Chorus docs. And the version that is displayed is available for everyone is here. That's the official Federa Chorus, Federa Docs website. Unfortunately, the website is not updated every time somebody commits. And every time a commit gets in, so it's lagging a little bit behind. It's something like once a day. So you will not have the pleasure of doing your work be available right now on the website. You will have to wait for tomorrow. The idea, so if you need any help with Federa Chorus, you can start with the existing documentation. There are instructions for either launching in cloud providers or directly on your system. And of course, if you want to work on the docs, you will probably want to preview the changes that you've made locally. And that's easily done by the link here by the very short instructions. You basically need Podman or Docker and that's it. Writing documentation is great, but making it available to more people is also great. So we if you want to work on the translation, you can head over there to the translation page. So I'll give it a quick look here. So that's the Federa Chorus documentation, the translation page. I think this one is in French because I'm in France and you can go over each page and translate strings in the documentation. That's easy and yeah, that would greatly help. If you want, if you're ready to go in and dive into Federa Chorus and write new docs, we've made a sample PR here on GitHub. Oh, that's not the one. That's sorry. So if you want to go in and you have made some suggestions about what you could work on and help us do. So it's on the Federa Chorus docs on GitHub. We put on GitHub and we've labeled the issue with good first issues and doc access to help you get started. Feel free to ask questions directly in the issues or in the chat and we'll try to help. So the documentation itself. Yeah, you can put most pages in the system configuration section. It's okay. That's not an issue. We will move pages if that's necessary. So we, yeah, we made, as I said before, we made a sample PR to help you get started. So if you want to like get the basics of how to create a page in the docs, that's the chances that you will need to do here. Okay, so we are quite a bunch here and I will be monitoring the charts and GitHub soon. To avoid stepping on each other. So the goal is to, you should have access to this document. I think it's, oh, it's limited to sign in user. So yes, as soon as you've signed in into ICMD, you should be able to edit it. So you can see the edit mark here. You can go there. It's marked down. And if you want to work on a specific issue, please add yourself here as your name and the issue you want to work on so that we don't work on the same, everybody does not work on the same issue. And we can assign issue to people on GitHub. So if you use your GitHub username, that will work great. So yeah, we prefer GitHub workflow, so Git and PRs, but if not comfortable with that, it's okay. You can do direct contribution using ICMD. So, similar to what we're showing right now and we will do what's necessary to make this into a final PR once you're ready. And that's fine. One note about ICMD, the preview mode of ICMD doesn't really support ASCII. But if you just use the plain text editor mode, it's just plain text on your screen. So don't worry too much about the rendering. Yeah. And thanks, Dusty. And the last things that you can do is testing the actual docs, the current documentation that we have to make sure that it's still relevant and still working. And so, at the same time here, the same idea here, we don't want to all work on the same page. So if you want to work on a specific page and try it and verify it, you can add your name here in the docs to tell everybody that you're working on this page, for example. And so we can speed the work. Just a quick note, as we are still updating the tutorials for Sunday Workshop, I suggest that you do not work on them because they have already changed from the version that is displayed in docs. So if you work on them, please do it from the version that is in the repository, the current master and expect changes to it. So yeah, everything else should be in better shape. But they are okay, but they are not fully completed. And that's about it. So. Timothy, a quick question on the testing. So if somebody wants to grab one of those sections to just run through and make sure the documentation looks good. I just added an example in that section that says my username and I will try to test this one. Does that look like what you were expecting? So if you scroll down on your screen. Yeah. Yeah, that's great. Maybe make it like a bold and that would be perfect. There you go. Oh, good. Are there any questions? Otherwise, I'll leave the floor to you. And let's let's do some docs. If you're more comfortable asking questions directly. So there's chat. There's the IC channel. There's here you can ask for for voice access. If I understood correctly in hoping so you should be able to ask questions directly if you'd like. Timothy question. So when I tried to get access for sharing my audio and video. I had to click a button and then like say apply to get added to the session. Did you approve me? Is that how I got added or okay, that's weird. I didn't do anything you you got in. Okay, I'm not sure how that works then because there was a period of time between when I applied and when I got in. So, yeah, I think Jonathan might be having some trouble getting his video and audio shared too, but we'll just deal with those issues. We've got the the event the session channel here in Hoppin and then also Fedora Coro s on free node. So if people have any questions just ask those there. Hey, can you hear me okay now? I think you muted but by your expression I think it's yeah. Oh, you can't hear me. I can hear Timothy. I'm not Jonathan. It's your Jonathan. Yeah, it's your Jonathan. Can you say something now? Yep. Yeah, I can hear you. All right. Welcome. Thanks. Thanks for leading the beginning. That's the end. So Jonathan, as a user coming into this, what would you do in order to contribute to the docs? What's your first step? I think I would fork the repo and then I would clone it locally. And I would just try to build and preview it on my laptop. And then once I have that, then I can, you know, maybe see what what issues interest me. Or if I've never tried for a course before, I would definitely either try to use the bird or Kevin you to to play around with it and just make sure I understand like how to pass an English config to the VM. And if you've never used Fedora or OS before, you can easily sign up to just test a section of the docs. And, you know, make sure that it's good for a new user, right? So that's, that's a good way to contribute as well. Timothy, do you want to pull up on that your screen share the example PR to get hub repo and just step through that briefly. Here you should be able to see, let me check, yeah, the example PR for the repo that we've made. So it's in the docs of the in the middle here. And the basic idea is if you you'll start with adding your page here in the nav section. It's a bicycle file, which is all the sections that are in the documentation. So you can see here it's been it's and don't need auto sanitation canal tuning. So that would get under the right here. And once you've added the page here, so you see here you had just the name of the document that you meant to reference. You need to put the full pass. And here you just created in almost the same directory just underneath the pages directory here. You had a new page, same name, which is wrong. You did not put the same name. I'll go fix that. Yeah, I called it new example, but then I just changed it to example and I didn't change the file name. So I'll go fix that's all right. Yeah, you write directly has to dog here and that will create you do a page for you. I can show that was a test. That was a test. I wanted to make sure you caught it in code review. And yeah, ASCII doc is like close to markdown but not exactly the same. So depending on how comfortable you are with markdown, it's going to be easy. I don't know if the reference is here somewhere. Maybe we can find it. There should be some reference here. Well, doesn't really. It's easy to like copy paste from the existing doc. I would say that's the way to go. So things, what's happening? So for some of the issues, I added a sentence criteria to try to make it clear what we wanted out of the issue. But I didn't get through all of them. But if you have a doubt about or some of them are maybe already clear enough. So if you have a doubt about what needs to get done for a specific issue, you can ask us in chat or any issues. I have a question about translations. So how does that typically work? Is there anything that's auto translated? Or is it completely all like kind of manually done? And so for example, if I go in and I change a section, like I change a paragraph, does somebody then need to go in and like change the translation? Yeah. So if I go to the translation website here, let's be just signing. So if I go to federal chorus and so previously I had done all of these. So let's go for index. For example, there are some strings to check here. Oh, so there have been changes. So that's a good example of what you ask. I had translated the initial index page in French for the federal chorus docs. And so they have been changes and they are shown here. And so you've got so the changes, the English version, the new English version, which has double spaces. So it should be fixed. And that's the final French version that I had originally that I should update. Okay. I'll just edit this one. And when it's done, I'll go save. So I'll do this in a second. But just underneath you can see all of the strings that I have to, that I have that are there to translate and some checks here. How does it, how does it break up into different sections? Does it just use like a single line of text or does it just do paragraphs? Like if I, if I write a section of documentation and I manually line break a couple of times, does it pick that up or no? I think it's paragraphs that so far from what I've seen. Okay. Thanks for the tutorial. Sure. Yeah, somebody started translating here. Okay. So I'm going to start hacking on some docs. You know, I'll periodically look at the chat and the channel here and also in Fedor Coral S. And, you know, if anybody has any questions asked to share your audio or video or post them in the chat and happy hacking did update the example PR. So it should be better. Seems like we have a couple of questions about translations. Maybe we can debug Raphael's issue on your screen, Timothy. And for Sylvia, maybe we can do like a how to get started with translations brief, many tutorial. Yeah. Yeah. So let me, so you get interested and check. I'll do a recap translation so that, so let me write this one as in progress. So if you go on the HackMD, you can see here the link for translations. So it's the Fedora translate the web late service. So if I go there, you hear you need to sign in, you should sign in. It's, I think it's not required, but it's better if you sign in using your Fedora account ID, because you can then directly save the translations and that's easier for you and for everybody. You, you will get more power in a way. So once you sign in here, you should go to the Fedora course page. So if you are on the dashboard, for example, and you want to look for it, you can go over here. Look at the project blues or projects. And then you can search for chorus or OS. Oops. And there you go. So I would recommend to, let's say, get started with the easiest one is index. So basic page, landing page. So you should click here on the index page. You will see multiple language. If your language is not already there, you should do start a new translation. And then you have to choose language. So pick the one you want to do and go ahead and start a new translation. Once you've done that, you should be rigid either with the page like this with all the language or directly here on the page here. So if you can translate, you can get into this interface here where you get all the strings to translate and you get them one by one. So you have to read the English version here and translate it here in a language. Once you're done, if you feel like it's okay, the transition is perfect. You don't think it needs any work. You can go and save it directly. If you feel like it's not complete or maybe it should be better, you can go and check the box here to say that it needs editing or put it as a suggestion. Or if you don't want to do this string right now, you can just skip it and move to the next one. And so that just like here, it goes through all of the texts and you should translate each one of them. If you want to skip to a specific one, you can go underneath here. You've got all the strings to translate and you can click on one and you will be sent to it. You can watch out and write for this box here. Things to check sometimes when you make mistakes or if there are something that is inconsistent, you will get a warning here and you can see, well, it depends on the issue you have. Does that helps? Let me check the chat. Usually you can like overwrite most of the web late checks. So if you think you're right, you just go ahead and overwrite it. And it doesn't matter. Weird. It's translate not fedora project.org down for anybody other than me. If you try to open a new one. Working here. Just me. That's good news because I'm glad everybody who's editing things in a browser window isn't going to lose some. It's DNS. Always. Timothy, we got a specific question about translations in the chat. Maybe you can help Sylvia with that particular issue. Right. So when you have links, so let me find this one. When you have links, you have to keep the links in English. So this one should be the index, maybe. Yeah. So here. So you can see it in the source in English, you have the link here. So that that part you have to keep it as is. And then you get the actual content that is displayed to the user. And that's the one, the one you want to translate. So he has translated it to French and everything else I've kept has this. I think. Is there a time this session ends by the way. Yeah, that's about it. Technically 1150. So now. Okay, cool. I don't know. You know, we might get kicked out at some point. I'm sure people have other sessions they might want to join as well. Should we kind of close out the session. And, you know, obviously what people are working on the open PRs and we'll just go through it that way. And obviously if people have questions, we're also in Fedora or less on free note. So we'll be available. Yeah. And I mean, if you want to contribute, like if you're doing translation right now, but you also want to contribute with adding new docs. There's still like all the issues in the in the GitHub repo with the good first issue label. So you can always, you know, after after this hack fest, pick whatever you want. And docs are always always welcome. Okay, I guess that's it then. Tim, did you want to say anything else before we finish? Yeah, just some closing remarks that such as thanks everyone for joining us today and for writing docs. I think he might be having translation. I can I can hear Timothy. Okay. Yeah, I don't know if John can hear us. Thanks. Thanks for joining us and and for working on docs. I see some translations have been. We've been some date. Yeah. We've got new translations. That's great. And yeah, and I've seen some PRs too. So that's cool. And so thanks everyone. Thanks everybody. And they will stay. I will stay here for a while. And we are still available in the chat in the events, of course, and on free node as just he said, feel free to ask any questions on the charter directly. And we'll be there for the next session, which will be on Sunday morning for the federal chorus workshop, which is like the getting your hands dirty with federal chorus session. If you haven't done that already in this one. And there are a lot of federal chorus. There are multiple federal chorus sessions during this event. There's something on OKD, I think. And another one about introduction to federal chorus or something like that. I don't remember. Yeah, it's kind of funny the OKD session actually got scheduled at the same time as this one. So that happened at 1030. So go back and watch it later. And there is a federal chorus talk tomorrow and then the workshop on Sunday. So yeah, thanks everyone. I'll stay here for a while and see you maybe on Sunday. Oh, anytime during the chat in the chat. Thanks everybody.