19:00:57 #startmeeting Docs Office Hours 19:00:57 Meeting started Thu Jun 9 19:00:57 2022 UTC. 19:00:57 This meeting is logged and archived in a public location. 19:00:57 The chair is bcotton. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions. 19:00:57 Useful Commands: #action #agreed #halp #info #idea #link #topic. 19:00:57 The meeting name has been set to 'docs_office_hours' 19:01:05 #chair pboy 19:01:05 Current chairs: bcotton pboy 19:01:13 .hi 19:01:14 pboy: pboy 'Peter Boy' 19:01:39 #info this is an open meeting to discuss the new content strategy for Fedora's user docs 19:01:51 #link https://communityblog.fedoraproject.org/fedora-docs-is-about-to-change-significantly-check-it-out-still-in-statu-nascendi/ 19:01:58 .hi 19:01:59 heidal[m]: Sorry, but user 'heidal [m]' does not exist 19:02:38 .hi 19:02:39 heidal[m]: Sorry, but user 'heidal [m]' does not exist 19:02:40 .hi 19:02:41 marcdeop[m]: Sorry, but user 'marcdeop [m]' does not exist 19:03:54 welcome, nonexistent friends :-) 19:03:55 zodbot is bitchy today. 19:05:39 I am curious to see what is going on and if I can help 19:05:58 marcdeop: we're always looking for help :-) 19:06:38 the short version is that we want to present docs to the user based on the variant (e.g. Workstation, KDE Plasma, etc) with shared source asciidoc files where appropriate 19:07:14 The planning is clear to me. 19:08:16 so each variant would have it's own Installation Guide, for example, but they'd all use the same source when the content is the same 19:11:08 pboy, perhaps you could speak to specific ways people could help contribute? 19:11:56 Well, first It is a significant change and we would like to get feedback on it. 19:12:18 Is it plausible? will it improve documentation? 19:12:34 I presume the path to part 1 is already laden. I'm curious what else is on the pipeline. Keen to know if there is something a newbie or casual contributor can assist with. 19:13:20 heidal[m] at the moment nothing decided yet. 19:14:21 The restructuring will keep us very busy for some time. 19:15:08 In addition, there are some ideas. For example, QuickDoc needs some maintenance. 19:15:27 We need a style guide. 19:15:51 to name just two. 19:16:00 hankuoffroad: also, the F36 release notes still have open issues. that's a good list of small contributions to make https://pagure.io/fedora-docs/release-notes/roadmap/F36 19:16:47 To also newbies and occasional contributor can help a lot. 19:16:55 pboy: How many contributors stepped forward for QuickDoc? 19:17:38 heidal[m]. We haven't planned it that precisely yet bar. 19:18:06 hankuoffroad: most of the quickdocs contributions are one-off. we don't have a lot of sustained contribution there at the moment 19:18:40 Example for newbies: Review of the revised texts. Are they helpful? understandable? is something missing? 19:19:21 pboy: oki, is there something like this for Docs? https://pagure.io/fedora-server/boards/Works%20in%20progress 19:19:53 Yes, bcotton knows the link 19:20:09 pboy: #agreed 19:21:55 bcotton, do you have the link at hand? 19:22:18 pboy: i had to wait for Pagure to come back online so I could see the comparison 19:22:28 are you referring to https://pagure.io/fedora-docs/docs-fp-o/issues ? 19:22:45 yes, it is https://pagure.io/fedora-docs/docs-fp-o/boards/Documentation%20Content 19:24:06 pagure is a bit slow today 19:25:28 bcotton: That's correct. I saw it. I'll dig into this. 19:26:30 heidal[m] We are in the process to migrate everything to gitlab. So everything is in flux regarding organisation. 19:27:12 "We need a style guide." <- I must confess this is beyond me. 19:28:24 heidal[m] Yeah, it is a very special task. :-) But we have other things in quantities. 19:28:53 review, editing texts things like that. 19:29:30 even "just" review and comment is very useful and improves qualitiy. 19:33:39 pboy: Cautious to point out that I see some inconsistency in code conventions among editions. 19:34:16 could you give an example? 19:34:27 I'm grateful to docs I heavily used for my baby steps to set up ARM server. 19:35:42 pboy: when commands are inserted into Docs, some editions have a space between the prompt and commands. Some editions use [...], others have different convention. 19:36:22 yes, I see, that's a matter of the missing style guide, indeed. 19:36:51 Currently it completely depends on the author's way to do it. 19:37:58 some books even omit $ because it is repetitive. I know $ is widely accepted. 19:38:45 Usually $ is an indicator for non-root priviledge, and # for root. 19:39:27 And some use [...] as indicator of an inout prompt in contrast to a system responce. 19:40:13 For all these things we need a style guide. And an info for the reader, what is an indicator for something. 19:40:47 #agreed 19:42:40 Regarding ARM server: we are in need of use cases and tutorials as part of the server documentation. contributions are very welcome. 19:43:17 What's the criteria to get involved with contribution to docs? I saw membership discussions earlier this year, but didnn't participate in voting. 19:43:56 There are no prereqisite criteria. everyone is welcome. 19:44:34 pboy: I thought that was more of magazine articles. After I finished one article, I already hit the writer's block :) 19:45:27 Yeah, that happens to professional writers too 19:45:49 pboy: Good to know. This is the first time I dipped into this meeting. 19:46:54 Regarding Magazine Artikels. They are of limited lenght and details. 19:47:35 Many can be extended and are then a good tutorial or use case description. 19:47:52 as part of Fedora documentation. 19:48:02 Which meeting should I attend for Docs workgroup? is fedora-docs@irc.libera.chat ? 19:48:33 Yes, that is our weekly meeting. 19:48:44 that's our regular chat channel. we have meetings in #fedora-meeting-1 on Wednesdays 19:49:01 at 1830 UTC if I did the timezone math right :-) 19:49:01 Yeah, sorry, my fault. 19:49:18 1820 UTC yes. 19:49:25 1830!! UTC 19:49:34 Mori 19:49:43 ah i got it. I now synced Fedocal with my calendar. No, it was my ignorance on UTC and GMT. 19:49:55 More livid is discussion.fedoraproject.org. tag #docs 19:50:25 that works for me because I live in UTC+1 zone. 19:50:43 Me to :-) 19:51:15 I saw some German text in docs, is that you? 19:52:13 I fear yes. :-) 19:52:31 Must have been the translator's failure. 19:52:58 We need a pair (or two or mote) of eyes :) 19:53:12 Therefore we need reviews. :-) 19:53:50 An author is always bad as a proofreader of his own text. 19:54:28 Comments before publication (like editors or proofreaders) ensure my article is not subject to nitpicking (due to grammatical or contextual error, sheer stupidity of mine) or a grave issue (controversy). It is sort of sense check and foolproofness. 19:55:00 Comments after publication help me find dead spot, which I overlooked. 19:55:55 I didn't plagiarize it. Just came from the other day and wanted to share 19:57:04 +1 19:58:56 "An author is always bad as a..." <- At the Magazine, Richard England and Gregory helped me a lot. 19:59:56 Me too. Fortunately, they do a review on every article. 20:01:32 okay, the hour is up. Thanks to everyone who came by, and we'll see you in #docs:fedoraproject.org or in the #docs tag on discussion.fedoraproject.org 20:01:35 I see, out time is up. 20:01:35 #endmeeting