fedora_documentation
LOGS
18:30:49 <darknao> #startmeeting Fedora Documentation
18:30:49 <zodbot> Meeting started Wed Mar  9 18:30:49 2022 UTC.
18:30:49 <zodbot> This meeting is logged and archived in a public location.
18:30:49 <zodbot> The chair is darknao. Information about MeetBot at https://fedoraproject.org/wiki/Zodbot#Meeting_Functions.
18:30:49 <zodbot> Useful Commands: #action #agreed #halp #info #idea #link #topic.
18:30:49 <zodbot> The meeting name has been set to 'fedora_documentation'
18:30:57 <darknao> #chair bcotton pboy mroche darknao pbokoc py0xc3
18:30:57 <zodbot> Current chairs: bcotton darknao mroche pbokoc pboy py0xc3
18:31:06 <darknao> #info Today's agenda is at: https://discussion.fedoraproject.org/t/wag-about-our-irc-meeting-tomorrow-wednesday/37456/2
18:31:08 <darknao> #topic Roll call
18:31:10 <darknao> .hi
18:31:11 <zodbot> darknao: darknao 'Francois Andrieu' <darknao@drkn.ninja>
18:31:23 <pboy> .hello2
18:31:24 <zodbot> pboy: pboy 'Peter Boy' <pboy@uni-bremen.de>
18:31:36 <copperi[m]> .hello copperi
18:31:37 <zodbot> copperi[m]: copperi 'Jan Kuparinen' <copper_fin@hotmail.com>
18:31:43 <shaunm[m]> .hello
18:31:43 <zodbot> shaunm[m]: (hello <an alias, 1 argument>) -- Alias for "hellomynameis $1".
18:32:02 <shaunm[m]> .hello shaunm
18:32:02 <zodbot> shaunm[m]: shaunm 'Shaun McCance' <shaunm@gnome.org>
18:32:44 <pbokoc> .hello pbokoc
18:32:45 <zodbot> pbokoc: pbokoc 'None' <pbokoc@redhat.com>
18:34:01 <darknao> welcome everyone!
18:34:14 <darknao> #topic Announcements
18:34:16 <darknao> #info F36 Beta release target date is 2022-03-15
18:34:18 <darknao> #info Go/No-Go meeting is this thursday (2022-03-10)
18:34:20 <darknao> #info We're using the docs-fp-o repo to track meta-work
18:34:22 <darknao> #link https://pagure.io/fedora-docs/docs-fp-o/issues
18:34:50 <darknao> any other announcement to add?
18:35:59 <darknao> I guess not :)
18:36:08 <darknao> #topic Previous action items
18:36:15 <darknao> #info pbokoc to cherry-pick antora 3.0 changes for Install Guide and Sysadmin Guide
18:36:28 <darknao> I think this is done, right?
18:36:31 <pbokoc> yeah, that's done
18:36:42 <darknao> #info done!
18:36:59 <darknao> alright, now is the fun part
18:37:06 <darknao> #topic docs-fp-o backlog refinement
18:37:33 <darknao> before we start, is there anything you want to discuss?
18:38:52 <darknao> ok, let's get started then
18:38:55 <darknao> .showticket https://pagure.io/fedora-docs/docs-fp-o/issue/%s 2
18:38:56 <zodbot> darknao: Issue #2: Add Search - docs-fp-o - Pagure.io - https://pagure.io/fedora-docs/docs-fp-o/issue/2
18:39:26 <pboy> I looks as if it is work in progress ?
18:40:20 <darknao> it's a work in progress indeed. My take on lunr plugin is not very promizing, but I (or anyone else) need to take a closer look
18:41:21 <pboy> We had several offers, in the last days. What about those?
18:41:39 <pboy> Was it about lunr plug in, too?
18:42:59 <darknao> i think the last offer was to use Elastic Search
18:43:33 <darknao> but that require an additional service to host on our infra
18:43:52 <pboy> Maybe, it was an idea from me, as an alternartive to outsourcing the search
18:44:31 <pboy> additional service seems: it is not easy and not short term
18:44:47 <pboy> Maybe, you should tag it as "in progress" and we schedule a discussion about the state in 14 days?
18:44:57 <pboy> As Preparation, can someone summerize the discussion and the oferings?
18:45:30 <pboy> oferings -> offerings
18:45:39 <darknao> agree. the lunr extension is in active development from the Antora team, so i expect some changes/optimization in the next few months
18:47:08 <darknao> ok, next one
18:47:23 <darknao> .showticket https://pagure.io/fedora-docs/docs-fp-o/issue/%s 8
18:47:24 <zodbot> darknao: Issue #8: Document how to make links like https://docs.fedoraproject.org/f26/release-notes/ work - docs-fp-o - Pagure.io - https://pagure.io/fedora-docs/docs-fp-o/issue/8
18:47:57 <darknao> not sure about this one
18:48:33 <pbokoc> I think that's a leftover from when Antora was first deployed on docs.fp.o, a lot of things were completely broken initially
18:48:40 <pbokoc> I'd say we can close that one
18:48:43 <darknao> i think it was about document url ending with `something.html` in the past
18:49:06 <pboy> Let's close it as outdated.
18:49:25 <copperi[m]> +1
18:50:40 <darknao> .showticket https://pagure.io/fedora-docs/docs-fp-o/issue/%s 9
18:50:41 <zodbot> darknao: Issue #9: In general, removing an HTML page and going to the directory level should not give a 403 - docs-fp-o - Pagure.io - https://pagure.io/fedora-docs/docs-fp-o/issue/9
18:51:00 <pboy> Seems to be outdated? (F26) Outdated anyway?
18:51:22 <pboy> a leftover as #8?
18:52:19 <pbokoc> well, the issue still exists
18:52:50 <pboy> OK, then we shouldn't close it.  :-)
18:52:51 <darknao> yeah, https://docs.fedoraproject.org/en-US/fedora/f35/system-administrators-guide/servers/ for instance, still return a 403
18:53:08 <pboy> Oh, that's me. :-)
18:53:44 <pboy> Oh, I'm not
18:53:47 <darknao> but it is really an issue? I mean, unless you manually enter this url, you shouldn't end up here anyway
18:54:26 <copperi[m]> Do you find such urls on search engines and such ?
18:55:22 <darknao> i don't think so, there is no content to index on those pages
18:55:38 <pbokoc> It seems to me that this only appears if you use topics - directories within modules/<module-name>/pages. If you do that, then deleting a part of the URL will give you a 403. Relnotes and the Install Guide both do that
18:55:45 <pbokoc> but most repos don't
18:56:00 <pbokoc> sysadmin guide too
18:57:02 <pbokoc> but anyway, yeah, nothing is generating links to those URLs. Bex mentions using aliases to fix that, but I think we'd have to maintain those by hand and that's just not worth it
18:57:21 <pbokoc> especially since nothing generates links to those 403s, you really have to delete a part of the URL to get there
18:58:34 <copperi[m]> Does antura support generic (own) 403 page that would redirect to main page?
18:58:58 <darknao> maybe we can tag this ticket as low priority and ask the reporter if this is still relevant today?
18:59:24 <pboy> We may document that this structure is to avoid  in an  authors guide.
18:59:36 <pboy> darknao +1
18:59:37 <darknao> copperi[m]: I think Antora only support custom 404, but no 403
18:59:54 <pbokoc> we could, yeah. Also it's a relatively easy fix, if you put an index.adoc into each topic directory, then you get the index page instead of a 403.
19:00:14 <copperi[m]> darknao: ok, tag as low priority
19:00:14 <pbokoc> and... is there a way to set up a redirect inside an adoc page? I vaguely recall something like that
19:00:50 <darknao> yeah i think there is an alias feature you can use for that
19:01:47 <pbokoc> ok, I'll take a stab at it. If it works then we could just put in those index files once, mention it in contributor docs in case someone wants to use topics in another repo, and it wouldn't require any additional maintenance
19:02:18 <darknao> ok nice
19:02:28 <darknao> thanks pbokoc
19:02:52 <darknao> .showticket https://pagure.io/fedora-docs/docs-fp-o/issue/%s 16
19:02:53 <zodbot> darknao: Issue #16: Stable URL for the current version's documentation - docs-fp-o - Pagure.io - https://pagure.io/fedora-docs/docs-fp-o/issue/16
19:03:15 <pboy> Seems to be work in progress?
19:03:25 <darknao> ok so this one is pretty much implemented
19:03:46 <darknao> deployed on staging, but not on prod (beta freeze in progress)
19:04:23 <darknao> i think there is a topic about it
19:04:36 <pboy> Please, would you add a corresponding comment and we will close it as soon as it is deplyed?
19:07:00 <darknao> done
19:07:12 <darknao> .showticket https://pagure.io/fedora-docs/docs-fp-o/issue/%s 18
19:07:12 <pboy> thanks!
19:07:13 <zodbot> darknao: Issue #18: Google detects no structured data - docs-fp-o - Pagure.io - https://pagure.io/fedora-docs/docs-fp-o/issue/18
19:08:54 <pbokoc> I don't know anything about Google Analytics but right now the page isn't reporting any errors so I think that's been fixed.
19:09:13 <darknao> Not sure if structured data will be useful for documentation website, but maybe someone wants to take a look?
19:09:17 <pbokoc> Coverage
19:09:18 <pbokoc> 0 pages with errors
19:09:18 <pbokoc> 29,408 valid pages
19:10:05 <darknao> i don't think this was about an error, but more an improvement on how the content will be displayed on the search engine
19:10:24 <darknao> https://developers.google.com/search/docs/advanced/structured-data/search-gallery?hl=en
19:11:14 <pbokoc> ah, right, that sort of thing
19:11:37 <pboy> That's not unimportant, but may be tag as currently low priority ?
19:11:51 <pbokoc> +1
19:12:11 <copperi[m]> +1
19:12:51 <darknao> ok done
19:12:55 <darknao> next
19:13:02 <darknao> .showticket https://pagure.io/fedora-docs/docs-fp-o/issue/%s 22
19:13:03 <zodbot> darknao: Issue #22: Document how to get a release note into Fedora - docs-fp-o - Pagure.io - https://pagure.io/fedora-docs/docs-fp-o/issue/22
19:13:47 <pbokoc> hmmm.
19:14:48 <pbokoc> Yeah, the process is "open an issue for release-notes and preferably start the title with the release it's relevant to". People occasionally do that but it's not documented anywhere
19:15:07 <pbokoc> but I don't know where we should do it. I mean it's kinda intuitive I think
19:15:28 <pbokoc> bcotton would probably have some input on this
19:16:42 <pboy> Can we treat this at all? Isn't that a matter for bcotton or FESCo?
19:17:16 <pboy> This process is their responsibility.  I think?
19:18:58 <pbokoc> Ben opens issues for accepted Changes and he knows what to do so that's not a problem, but once in a while there's something that didn't go through the Change process that someone wants documented anyway, usually like 1-2 issues per release
19:20:02 <darknao> i've added a comment asking bcotton for advice
19:20:26 <pboy> darkno +1
19:20:56 <darknao> we are almost over, so this is the last one for today
19:21:07 <darknao> .showticket https://pagure.io/fedora-docs/docs-fp-o/issue/%s 26
19:21:08 <zodbot> darknao: Issue #26: Doc to write: Getting help, common bugs, etc. - docs-fp-o - Pagure.io - https://pagure.io/fedora-docs/docs-fp-o/issue/26
19:23:01 <pbokoc> right, that's basically a request for a new doc
19:23:13 <pboy> Well, is a good idea. We need a place to put it and someone to write a text
19:23:23 <pbokoc> yeah, exactly
19:24:25 <pboy> I would have no problem writing a text. But how urgent is it? (I have so many texts to write right now for Server).
19:25:23 <copperi[m]> I think there are how to get help pages already, should just modify one of those and get place to put it in.
19:25:43 <darknao> for now, we still have the link to the wiki page with this kind of information, so my guess is it's low priority but nice to have
19:25:55 <pbokoc> pboy, it's been open since 2017 so I'd say it's not very urgent :)
19:26:44 <pboy> Probably tag as low priority?
19:26:56 <pbokoc> yup
19:26:57 <darknao> yep, done
19:27:12 <darknao> ok, that was a good run
19:27:19 <darknao> #info Open floor
19:27:29 <darknao> #undo
19:27:29 <zodbot> Removing item from minutes: INFO by darknao at 19:27:19 : Open floor
19:27:34 <darknao> #topic Open floor
19:27:34 <pbokoc> heyyy, we're being productive! :)
19:27:48 <pboy> OInded, I found that very productive today!
19:28:06 <darknao> we should do that every two weeks or something
19:28:10 <pboy> Hope we can continue that way
19:28:24 <copperi[m]> darknao: yep
19:28:58 <pboy> darknao you are the natural chair
19:29:32 <darknao> by the way, i've created a few tags to categorize these issues, but if you see any others to add or rename, let me know
19:30:44 <darknao> alright, thank you everyone! See you around :)
19:30:48 <pbokoc> o/
19:30:48 <pboy> I'm wondering to create a board "work progress" or alike
19:30:54 <darknao> #endmeeting