| *** jamesmcarthur has joined #openstack-doc | 00:06 | |
| *** jamesmcarthur has quit IRC | 00:11 | |
| *** ianychoi has quit IRC | 00:57 | |
| *** ianychoi has joined #openstack-doc | 00:59 | |
| *** jamesmcarthur has joined #openstack-doc | 02:20 | |
| *** jamesmcarthur has quit IRC | 02:41 | |
| *** jamesmcarthur has joined #openstack-doc | 02:44 | |
| *** jamesmcarthur has quit IRC | 03:26 | |
| *** kopecmartin|off is now known as kopecmartin | 05:08 | |
| *** dmacpher has quit IRC | 05:31 | |
| *** dmacpher_ has joined #openstack-doc | 05:31 | |
| *** miloa has joined #openstack-doc | 06:01 | |
| *** ianychoi has quit IRC | 06:34 | |
| *** ianychoi has joined #openstack-doc | 06:34 | |
| *** ianychoi has quit IRC | 07:00 | |
| *** ianychoi has joined #openstack-doc | 07:01 | |
| *** brinzhang_ has joined #openstack-doc | 07:01 | |
| *** brinzhang has quit IRC | 07:05 | |
| *** brinzhang has joined #openstack-doc | 07:05 | |
| *** brinzhang_ has quit IRC | 07:06 | |
| *** rcernin has quit IRC | 07:14 | |
| AJaeger | stephenfin: I updated https://review.opendev.org/676739, could you +1 the release again, please? | 07:56 |
|---|---|---|
| asettle | AJaeger, for the record - I never mind :D thanks for fixing that | 08:31 |
| *** ianychoi has quit IRC | 08:32 | |
| AJaeger | ;) | 08:33 |
| *** ianychoi has joined #openstack-doc | 08:33 | |
| AJaeger | asettle, stephenfin, could you go over these related projects (ops-guide, ha-guide) and approve a simple job change, please? https://review.opendev.org/#/q/status:open+++topic:promote-docs | 08:34 |
| asettle | You got it | 08:36 |
| asettle | AJaeger, remind me - where do you find the time to do *this* and your day job? | 08:37 |
| AJaeger | don't ask ;) | 08:38 |
| AJaeger | focussing on small things that make a good impact and are scriptable ;) | 08:39 |
| asettle | Haha! Got it. | 08:39 |
| asettle | Lessons to be learned | 08:39 |
| AJaeger | ;) | 08:42 |
| *** jawad_axd has joined #openstack-doc | 09:20 | |
| *** hemna has quit IRC | 10:54 | |
| *** jamesmcarthur has joined #openstack-doc | 11:49 | |
| *** jamesmcarthur has quit IRC | 12:07 | |
| *** jamesmcarthur has joined #openstack-doc | 12:08 | |
| *** jamesmcarthur has quit IRC | 12:28 | |
| *** jamesmcarthur has joined #openstack-doc | 12:50 | |
| AJaeger | asettle, stephenfin, is https://review.opendev.org/664555 as you need it? amotoki says, he's happy ;) | 13:06 |
| * asettle looks in wonder | 13:08 | |
| asettle | Ohhhh | 13:08 |
| AJaeger | the current state of the change means that you have to use a new template for building PDFs. | 13:10 |
| stephenfin | AJaeger: If that's the case, should we also just be using a new tox environment? | 13:19 |
| stephenfin | I mean, if we have to modify projects, which is the thing we were trying to avoid, why not go the whole way and make it entirely reproducible locally? | 13:20 |
| *** tesseract has joined #openstack-doc | 13:22 | |
| *** tesseract has quit IRC | 13:22 | |
| AJaeger | stephenfin: you can change the review as well - and either introduce an "without-pdf" template, or force everybody to use PDF... | 13:23 |
| AJaeger | stephenfin: the change is one proposal of doing it ;) | 13:23 |
| AJaeger | and if you want a new tox environment: Yes, that would be possible but would need changes | 13:24 |
| amotoki | stephenfin: it turns out we cannot pass a variable to a project-template, so I see three routes now. (1) a new project-template as I do in the review (2) generate PDF but not to care failure of PDF build (3) a separate job | 13:25 |
| stephenfin | stephenfin: Oh, I'm still at the thinking out loud stage for the moment :) | 13:26 |
| asettle | That was very meta | 13:26 |
| AJaeger | it's basically three options: A) opt-in (current review), B) opt-out, C) force it down, no easy way out ;) | 13:26 |
| stephenfin | Whoops | 13:26 |
| stephenfin | talking to myself again. class | 13:26 |
| asettle | Explains a lot | 13:26 |
| stephenfin | AJaeger, amotoki: Which option do you prefer, and why? | 13:27 |
| AJaeger | I prefer an opt-in where the work is done in tox.ini as we discussed the last days - but I was outvoted ;) | 13:30 |
| amotoki | I prefer to opt-in approach whether we use a new project template, add a new command to tox or add a new tox env like pdfdocs. | 13:31 |
| AJaeger | openstack-tox-docs is run on each change in 100s of projects - so, if we force that in, many will run into problems. So, I'm against "force it down". I prefer an opt-in but will not block opt-out | 13:31 |
| *** brinzhang_ has joined #openstack-doc | 13:31 | |
| amotoki | AJaeger: when you say "opt-in", which aprpoach is in your mind? | 13:33 |
| amotoki | I see three opt-in ways as I wrote above. | 13:34 |
| *** brinzhang has quit IRC | 13:34 | |
| AJaeger | amotoki: I would just use tox docs environment and enhance it (and ensure that packages are installed like the role does, but no automatic building) | 13:35 |
| amotoki | AJaeger: It would be nice. My understanding of your idea is that each project needs to add commands to testenv:docs for PDF build like https://review.opendev.org/#/c/667968/4 but bindep.txt is unnecesary, right? | 13:37 |
| AJaeger | amotoki: that's my preference indeed | 13:39 |
| amotoki | The reason of my preference on opt-in is because it does not break many existing jobs (by forcing PDF build) and we can avoid PDF build breakage (from ignoring errors). | 13:44 |
| stephenfin | okay, so we're all in agreement that this should be opt-in and will involve per-project changes | 13:45 |
| amotoki | AJaeger: understood. Does each project need to move a PDF file or a job can fetch it? | 13:45 |
| stephenfin | To .zuul.yaml, tox.ini, and possibly the docs themselves to fix the issues we've seen in neutron, nova etc. | 13:46 |
| AJaeger | we could enhance the job to fetch PDF as well... | 13:46 |
| AJaeger | amotoki: I'm out basically the next two weeks, so I won't be able to help here... | 13:47 |
| amotoki | stephenfin: AJaeger: is the expected commands in tox.ini like https://review.opendev.org/#/c/667968/4/tox.ini? | 13:47 |
| AJaeger | amotoki: we could update the jobs to do the "cp doc/build/pdf/horizon.pdf doc/build/html/" | 13:48 |
| AJaeger | amotoki: otherwise that looks fine | 13:48 |
| stephenfin | amotoki: Similar. I think AJaeger was suggesting a wrapper script in openstackdocstheme that would only build PDFs if dependencies were present | 13:48 |
| stephenfin | Rather than calling sphinx-build directly | 13:48 |
| *** jawad_axd has quit IRC | 13:48 | |
| amotoki | AJaeger: yeah, 'cp' should be dropped. | 13:49 |
| stephenfin | I'm against that for the most part since I think it adds complexity and will docs builds slower | 13:49 |
| *** jawad_axd has joined #openstack-doc | 13:49 | |
| *** jawad_axd has quit IRC | 13:49 | |
| stephenfin | will make | 13:49 |
| stephenfin | not using the wrapper script removes that potential source of complexity but means everyone will need a working LaTeX toolchain present to build docs | 13:50 |
| *** jawad_axd has joined #openstack-doc | 13:50 | |
| stephenfin | and it still makes the docs build slower | 13:50 |
| stephenfin | so, personally, I'd prefer a separate testenv just for building PDF docs, and we can add a separate job which calls that or a new job which calls 'tox -e docs,pdfdocs' | 13:51 |
| stephenfin | the latter might be more efficient from a resource utilization perspective. I haven't given that much though | 13:52 |
| stephenfin | *thought | 13:52 |
| *** jawad_ax_ has joined #openstack-doc | 13:52 | |
| stephenfin | AJaeger: Have I convinced you, or do I need to try harder? :) | 13:52 |
| *** jawad_axd has quit IRC | 13:55 | |
| amotoki | I see three opt-in approaches (1) a new project-template (the current review) (2) add commands for PDF build to testenv:docs (3) add a new tox testenv (pdfdocs). | 13:55 |
| amotoki | we agree not to use (1). (2) is AJaeger's idea and (3) is stephenfin's. | 13:55 |
| stephenfin | yuup | 13:56 |
| *** jawad_ax_ has quit IRC | 13:56 | |
| amotoki | I have no strong preference between (2) and (3). Both detects PDF build failures. | 13:57 |
| AJaeger | stephenfin, there's always the strive for elegance and simplicity - and sometimes you have to choose ;) | 13:57 |
| AJaeger | stephenfin: you have convinced me that there's no perfect solution ;) | 13:57 |
| AJaeger | I would accept a new tox testenv | 13:58 |
| amotoki | (3) would be better for regular developers as they need no extra steps to build HTML docs. | 13:58 |
| amotoki | If they hit PDF build failure in their review, they can install PDF dependencies by following some instruction from us (or in future a wrapper script) | 13:59 |
| stephenfin | That's what I'm thinking too | 13:59 |
| stephenfin | Like I noted yesterday, the vast majority of the issues people are going to hit will be syntax-related | 14:00 |
| stephenfin | I still don't like the idea of having to go and propose patches across multiple projects but that seems unavoidable | 14:00 |
| amotoki | stephenfin: I understand your point, but most projects need some changes for better PDFs so I think adding a new tox env would not be a big problem. | 14:03 |
| stephenfin | amotoki: Agreed. To be clear, I'm complaining but I realize we don't really have another option :) | 14:04 |
| amotoki | this is a simple example of the change in horizon https://review.opendev.org/#/c/667968/4 (see changes under doc/source) | 14:04 |
| amotoki | a new tox env would be like this: http://paste.openstack.org/show/760940/ | 14:05 |
| amotoki | ? | 14:05 |
| AJaeger | amotoki: yep - depending on changes in jobs ;) | 14:07 |
| stephenfin | amotoki: Yup | 14:16 |
| *** csatari has quit IRC | 14:16 | |
| stephenfin | I had a great plan to remove the need for that 'make' step in Sphinx, but it never got anywhere :( | 14:16 |
| amotoki | AJaeger: stephenfin: we agreed on a new tox env 'pdfdocs'. How about job configuration? | 14:16 |
| *** irclogbot_1 has quit IRC | 14:17 | |
| stephenfin | I'd be happy with either (a) a new job that just called 'pdfdocs' or (b) a new job that called 'docs,pdfdocs' | 14:17 |
| *** irclogbot_1 has joined #openstack-doc | 14:17 | |
| stephenfin | or (c) a flag for the existing job to say "build PDFs too", but I don't think that's an option, right? | 14:17 |
| stephenfin | because of the templates | 14:17 |
| AJaeger | stephenfin: you can add the flag but then better use a new template... | 14:18 |
| amotoki | (a) needs a new projet-template too. (b) can avoid a new project-template but we need to explore how we can explore a way to check which tox env is available. | 14:19 |
| AJaeger | for jobs changes, you might want to talk with corvus on #openstack-infra | 14:19 |
| *** csatari has joined #openstack-doc | 14:19 | |
| stephenfin | Oh, this is another one of the issues I was seeing on the nova docs when I tried to build them. There were no Xindy packages on Fedora when I tried https://review.opendev.org/#/c/667968/4/doc/source/conf.py@269 | 14:19 |
| stephenfin | Good to know | 14:19 |
| amotoki | stephenfin: xindy is unnecessary. latex_use_xindy = False is specified. I need to drop xindy from the common job patch. | 14:25 |
| amotoki | asettle: Just notice: I will be out next week (monday might be online though), so perhaps I can resume the PDF goal work in the middle of the next next week at latest (after this week) | 14:41 |
| amotoki | asettle: so if the common job patch does not land this week, someone needs to take it over. | 14:42 |
| asettle | amotoki, thanks for the heads up | 14:43 |
| *** hemna has joined #openstack-doc | 14:52 | |
| hemna | morning | 14:52 |
| *** jamesmcarthur has quit IRC | 15:04 | |
| asettle | o/ | 15:09 |
| *** jamesmcarthur has joined #openstack-doc | 15:41 | |
| *** KeithMnemonic1 has joined #openstack-doc | 16:02 | |
| *** KeithMnemonic has quit IRC | 16:03 | |
| *** miloa has quit IRC | 17:31 | |
| *** kopecmartin is now known as kopecmartin|off | 18:33 | |
| openstackgerrit | Andreas Jaeger proposed openstack/contributor-guide master: use promote job https://review.opendev.org/677802 | 18:34 |
| *** factor has quit IRC | 18:52 | |
| *** factor has joined #openstack-doc | 19:55 | |
| hemna | is there a way to exclude files only for pdf generation? | 19:58 |
| AJaeger | hemna: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=only#directive-only | 20:03 |
| *** jamesmcarthur has quit IRC | 20:23 | |
| *** jamesmcarthur has joined #openstack-doc | 20:44 | |
| *** jamesmcarthur has quit IRC | 21:01 | |
| amotoki | hemna: an example is found in a proposed nova doc https://review.opendev.org/#/c/676730/3 | 21:09 |
| amotoki | stephenfin: AJaeger: asettle: I updated the job setup for PDF build. openstack-tox-docs is now used both for HTML/PDF build and HTML only build. | 21:14 |
| amotoki | A generated PDF file will be fetched at the log directory. An example is https://zuul.opendev.org/t/openstack/build/036080561bfe4dab840b68977c9be37a/logs | 21:15 |
| amotoki | is it fine to you? | 21:15 |
| *** jamesmcarthur has joined #openstack-doc | 21:16 | |
| *** altlogbot_2 has quit IRC | 21:16 | |
| *** rcernin has joined #openstack-doc | 21:27 | |
| *** altlogbot_1 has joined #openstack-doc | 21:36 | |
| *** altlogbot_1 has quit IRC | 21:38 | |
| *** altlogbot_1 has joined #openstack-doc | 21:40 | |
| *** altlogbot_1 has quit IRC | 21:42 | |
| *** jamesmcarthur has quit IRC | 21:46 | |
| *** jamesmcarthur has joined #openstack-doc | 21:47 | |
| *** jamesmcarthur has quit IRC | 21:51 | |
| *** jamesmcarthur has joined #openstack-doc | 21:51 | |
| *** jamesmcarthur has quit IRC | 22:15 | |
| *** threestrands has joined #openstack-doc | 22:34 | |
| *** hemna has quit IRC | 22:35 | |
| *** rcernin has quit IRC | 22:40 | |
| *** rcernin has joined #openstack-doc | 22:43 | |
| *** jamesmcarthur has joined #openstack-doc | 22:57 | |
| *** jamesmcarthur has quit IRC | 23:56 | |
Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!