fedora_docs
LOGS
15:30:32 <pbokoc> #startmeeting Docs Project Meeting
15:30:32 <zodbot> Meeting started Wed Jul 18 15:30:32 2018 UTC.
15:30:32 <zodbot> This meeting is logged and archived in a public location.
15:30:32 <zodbot> The chair is pbokoc. Information about MeetBot at http://wiki.debian.org/MeetBot.
15:30:32 <zodbot> Useful Commands: #action #agreed #halp #info #idea #link #topic.
15:30:32 <zodbot> The meeting name has been set to 'docs_project_meeting'
15:30:43 <pbokoc> #meetingname Fedora Docs
15:30:43 <zodbot> The meeting name has been set to 'fedora_docs'
15:30:50 <pbokoc> #chair bexelbie asamalik
15:30:50 <zodbot> Current chairs: asamalik bexelbie pbokoc
15:31:23 <bexelbie> .hello bex
15:31:24 <zodbot> bexelbie: bex 'Brian (bex) Exelbierd' <bexelbie@redhat.com>
15:31:33 <pbokoc> #topic Roll call
15:31:36 <asamalik> .hello2
15:31:37 <zodbot> asamalik: asamalik 'Adam Samalik' <asamalik@redhat.com>
15:32:45 * bexelbie is lurking as I am in a call at the same time
15:33:10 <pbokoc> bexelbie, we're more fun than a call
15:33:18 <bexelbie> yes
15:33:45 <pbokoc> #topic Antora migration
15:34:16 <pbokoc> #info We're aiming to migrate the docs site to Antora by Flock, which starts on Aug 8
15:35:03 <pbokoc> #link https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/kanban - Kanban board with things that still need to happen for the migration
15:35:44 <asamalik> I've sent emails to all groups that own a source repo
15:35:51 <asamalik> and also opened an issue in each source repo
15:36:12 <asamalik> saying that there will be a freeze starting Friday July 27
15:36:20 <linuxmodder> .hello2
15:36:21 <zodbot> linuxmodder: linuxmodder 'Corey W Sheldon' <sheldon.corey@gmail.com>
15:36:22 <asamalik> during which we'll migrate everything
15:36:52 <asamalik> and the site will be published in prod Wednesday August 1
15:37:07 <asamalik> should everything go as expected :)
15:37:15 <pbokoc> what could possibly go wrong!
15:37:56 <pbokoc> ok that sounds good. We still need to provide contributor docs, though, right? This, basically: https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/71?kanban-status=1046
15:38:00 * asamalik can't 🔥 think 🔥 of 🔥 anything
15:38:23 <asamalik> pbokoc: that's right
15:38:29 <asamalik> something is covered in the template repo https://pagure.io/fedora-docs/template/branch/antora
15:38:40 <asamalik> including a script for a local build and preview that works on Fedora and macOS
15:39:08 <pbokoc> nice. I need to try that out
15:39:09 <asamalik> so many people are welcome to play with it :)
15:39:37 <asamalik> and the whole site can be also easily built, documented here https://pagure.io/fork/bex/fedora-docs/docs-fp-o/tree/antora_playbook
15:39:42 <asamalik> the same way basically
15:40:10 <asamalik> so it looks like three things are missing before we can deploy it to prod
15:40:18 <asamalik> 1) content conversion, obviously
15:40:23 <asamalik> 2) onboarding people
15:40:29 <asamalik> 3) final design
15:40:56 <pbokoc> #todo: change the link in the template readme's "local preview" section to https://pagure.io/fork/bex/fedora-docs/docs-fp-o/tree/antora_playbook
15:41:23 <pbokoc> asamalik, ad design - do you mean styling with css or design as in structure etc.?
15:42:24 <asamalik> https://pagure.io/design/issue/605
15:42:27 <asamalik> that's the ticket
15:42:34 <asamalik> pbokoc: just the way it looks
15:43:03 <pbokoc> asamalik, right. That could theoretically wait till after deployment, right? We have some basic design available and if the visuals change after the move it's not a huge issue
15:43:26 <asamalik> pbokoc: well ideally it would be great to have that, but I wouldn't block on it
15:43:34 <pbokoc> that's what I mean, yeah :)
15:43:39 <asamalik> I would just deploy it ugly, yet functional :D
15:43:54 <pbokoc> just the way I like my software
15:44:35 <pbokoc> regarding onboarding, the main thing to do is write some half-decent contributor/publisher docs here
15:45:09 <pbokoc> we don't need to go into detail about e.g. how the shell scripts work, that can come later, just "run this to build" is IMO fine initially
15:45:24 <pbokoc> so the big thing is going to be content conversion
15:46:04 <pbokoc> asamalik, I don't suppose you have a magic converter script for that, do you :D
15:46:52 <asamalik> pbokoc: I have two scripts for content conversion.. one is called asamalik and the other one bexelbie :P
15:47:00 <bexelbie> yep
15:47:08 <bexelbie> it doesn't take that long once you've done it a few times
15:47:13 <bexelbie> and this is a one-time thing
15:47:29 <asamalik> it's just a one-off thing... we might hack something together
15:47:36 <asamalik> but yes, what bexelbie says
15:48:03 <pbokoc> right
15:48:05 <pbokoc> well have fun :D
15:48:57 <pbokoc> your sacrifice will be remembered. Btw, what will the conversion entail, is it basically just building a new yaml config for the site or are there syntax changes in the asciidoc itself?
15:49:04 <asamalik> pbokoc: we might even buy a doughnut or five as a motivation :P
15:49:27 <bexelbie> there is a small bit of content massage, iirc
15:49:33 <bexelbie> to fix image links and includes
15:49:37 <bexelbie> relatively automated
15:49:48 <bexelbie> automatable
15:49:54 <bexelbie> for certain definitions of automatable
15:50:10 <pbokoc> hmmm, yeah
15:50:37 <pbokoc> oh btw, does Antora validate sources when it builds, or do we need an external tool for that?
15:50:43 <asamalik> but it's a step forward
15:50:51 <bexelbie> can you define validation in this context?
15:51:05 <pbokoc> bexelbie, check that includes and xrefs work basically
15:51:09 <pbokoc> and images, ideally
15:51:28 <bexelbie> my recollection is that it doesn't do much more than asciidoctor does
15:51:42 <bexelbie> asamalik, ?
15:51:46 <pbokoc> cause right now I'm elbow deep in the disfigured corpse of quick-docs. Asciibinder at least prints warnings about bad includes but doesn't fail the build even when half the site is broken
15:52:26 <bexelbie> pbokoc, quickdocs needs some design thought too
15:52:29 <bexelbie> :(
15:53:03 <asamalik> bexelbie: linkchecker?
15:53:21 <pbokoc> yeah, we're getting to the point where we'll have to categorize the content. That can wait till after the migration though
15:53:22 * bexelbie runs that by hand after a build for most builds.  The automation will ideally do that too
15:53:28 <asamalik> quickdocs definitely need some love... that could be one of the next steps
15:53:28 <bexelbie> right now, the problems are in quick-docs :P
15:53:53 <pbokoc> yes
15:53:55 <pbokoc> many, many problems
15:54:55 <pbokoc> I'm also wondering how to allow contributors to validate before they push and make a MR. Checking at that point is good and everything but it would be nice to allow people to check before they commit
15:55:23 <asamalik> pbokoc: they could build the whole site on their machine
15:55:30 <asamalik> pbokoc: we can make that very easy
15:56:04 <asamalik> pbokoc: we could even run linkchecker as a part of the build and print out the errors for them
15:56:12 <pbokoc> hmm, that would be nice
15:57:20 <asamalik> pbokoc: the whole site can be built and previewed using a single command right now... the only thing that needs to be installed is docker
15:57:41 <pbokoc> asamalik, btw, regarding the contributor docs, the taiga card is currently assigned to you. Do you want to do it or should I take it so you can focus on conversion and deployment?
15:57:42 <asamalik> building some nice UX around including a specific branch or a local copy of the changes should be doable
15:57:59 <pbokoc> I mean this: https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/71?kanban-status=1046
15:58:02 <asamalik> pbokoc: if you'd like to do that, I would happily hand it over!
15:58:48 <pbokoc> I feel "like" is a bit strong word for that but I'll do it :)
15:59:32 <pbokoc> well, once I figure out how to do that
15:59:58 <pbokoc> I might not have the permissions for that actually, since it's asamalik's board
16:00:06 <pbokoc> also we're out of time
16:00:16 <pbokoc> does anyone have anything to add?
16:00:25 <asamalik> pbokoc: the board is definitely meant to be for everyone
16:00:38 <asamalik> it's just in my namespace since that's the only thing I could create
16:00:43 <asamalik> I'll add you
16:01:09 <pbokoc> ok thanks
16:01:13 <bstinson> pbokoc: i opened up the projects in ci.centos.org to you (sent you an email with creds)
16:01:26 <bstinson> is there an s2i builder we can use yet?
16:01:38 <pbokoc> bstinson, cool, thanks! (also I forgot to ping you at the start, didn't I)
16:01:50 * bstinson was lurking :)
16:01:56 <asamalik> bstinson: I've just managed to install Antora in a container after hours of struggle and debugging
16:02:06 <asamalik> $ antora site.yml
16:02:06 <asamalik> Segmentation fault
16:02:10 <bstinson> asamalik: nice
16:02:17 <pbokoc> alright :) There's no builder yet as far as I'm aware.
16:03:59 <pbokoc> anyway
16:04:01 <pbokoc> #endmeeting