| *** masaki has joined #openstack-doc | 00:02 | |
| *** thorst has joined #openstack-doc | 00:02 | |
| *** thorst has quit IRC | 00:08 | |
| *** gmann has quit IRC | 00:11 | |
| *** gmann has joined #openstack-doc | 00:11 | |
| *** fragatina has joined #openstack-doc | 00:19 | |
| *** fragatina has quit IRC | 00:24 | |
| openstackgerrit | Merged openstack/openstack-manuals master: Imported Translations from Zanata https://review.openstack.org/481583 | 00:29 |
|---|---|---|
| openstackgerrit | Merged openstack/openstack-manuals master: use the right flag to build api-ref list https://review.openstack.org/481064 | 00:29 |
| openstackgerrit | Merged openstack/openstack-manuals master: link to both api-ref and api-guide from listing page https://review.openstack.org/481065 | 00:29 |
| *** thorst has joined #openstack-doc | 00:36 | |
| *** thorst has quit IRC | 00:36 | |
| *** charcol has quit IRC | 00:39 | |
| *** s-shiono has joined #openstack-doc | 00:40 | |
| *** mriedem has quit IRC | 00:42 | |
| *** dmacpher has joined #openstack-doc | 00:50 | |
| *** caoyuan has joined #openstack-doc | 00:53 | |
| *** gouthamr has quit IRC | 01:13 | |
| *** fragatina has joined #openstack-doc | 01:20 | |
| *** fragatina has quit IRC | 01:25 | |
| *** thorst has joined #openstack-doc | 01:52 | |
| *** charcol has joined #openstack-doc | 01:54 | |
| *** thorst has quit IRC | 01:56 | |
| *** fragatina has joined #openstack-doc | 02:58 | |
| *** fragatina has quit IRC | 03:03 | |
| *** fragatina has joined #openstack-doc | 03:09 | |
| *** fragatina has quit IRC | 03:13 | |
| *** yamamoto has joined #openstack-doc | 03:47 | |
| *** Dinesh_Bhor has joined #openstack-doc | 03:52 | |
| *** thorst has joined #openstack-doc | 03:53 | |
| *** thorst has quit IRC | 03:57 | |
| *** dmacpher has quit IRC | 04:12 | |
| *** dmacpher has joined #openstack-doc | 04:25 | |
| *** ianychoi has joined #openstack-doc | 04:56 | |
| *** fragatina has joined #openstack-doc | 05:10 | |
| *** fragatina has quit IRC | 05:16 | |
| *** dmacpher has quit IRC | 05:24 | |
| *** dmacpher has joined #openstack-doc | 05:37 | |
| *** masaki has quit IRC | 05:49 | |
| *** masaki has joined #openstack-doc | 05:53 | |
| *** thorst has joined #openstack-doc | 05:54 | |
| *** phuongnh has joined #openstack-doc | 05:57 | |
| *** thorst has quit IRC | 05:59 | |
| *** AJaeger has quit IRC | 06:03 | |
| *** vijaykc4 has joined #openstack-doc | 06:05 | |
| *** AJaeger has joined #openstack-doc | 06:09 | |
| *** andreas_s has joined #openstack-doc | 06:20 | |
| *** vijaykc4 has quit IRC | 06:25 | |
| *** alexchadin has joined #openstack-doc | 06:27 | |
| openstackgerrit | OpenStack Proposal Bot proposed openstack/api-site master: Imported Translations from Zanata https://review.openstack.org/482015 | 06:37 |
| *** s-shiono has quit IRC | 06:38 | |
| openstackgerrit | Merged openstack/api-site master: Imported Translations from Zanata https://review.openstack.org/482015 | 06:44 |
| *** rcernin has joined #openstack-doc | 06:47 | |
| *** vijaykc4 has joined #openstack-doc | 06:53 | |
| *** belmoreira has joined #openstack-doc | 06:54 | |
| *** vijaykc4 has quit IRC | 06:57 | |
| *** suyog has quit IRC | 07:01 | |
| *** charcol has quit IRC | 07:04 | |
| *** amotoki_away is now known as amotoki | 07:11 | |
| *** fragatina has joined #openstack-doc | 07:13 | |
| *** fragatina has quit IRC | 07:17 | |
| alexchadin | AJaeger: ping | 07:18 |
| *** tesseract has joined #openstack-doc | 07:36 | |
| *** nicolasbock has joined #openstack-doc | 07:37 | |
| *** thorst has joined #openstack-doc | 07:54 | |
| *** masaki has quit IRC | 08:00 | |
| *** thorst has quit IRC | 08:00 | |
| *** phuongnh has quit IRC | 08:07 | |
| *** phuongnh has joined #openstack-doc | 08:07 | |
| *** fragatina has joined #openstack-doc | 08:13 | |
| *** fragatina has quit IRC | 08:18 | |
| asettle | Morning o/ | 08:29 |
| *** dmacpher has quit IRC | 08:39 | |
| *** phuongnh has quit IRC | 08:40 | |
| *** vijaykc4 has joined #openstack-doc | 08:51 | |
| *** tosky has joined #openstack-doc | 08:52 | |
| *** pblaho has joined #openstack-doc | 09:05 | |
| *** vijaykc4 has quit IRC | 09:20 | |
| *** thorst has joined #openstack-doc | 09:23 | |
| *** vijaykc4 has joined #openstack-doc | 09:26 | |
| *** thorst has quit IRC | 09:28 | |
| *** vijaykc4 has quit IRC | 09:43 | |
| *** vijaykc4 has joined #openstack-doc | 09:46 | |
| *** caoyuan has quit IRC | 10:02 | |
| *** fragatina has joined #openstack-doc | 10:16 | |
| *** masaki has joined #openstack-doc | 10:18 | |
| *** masaki has quit IRC | 10:18 | |
| *** fragatina has quit IRC | 10:20 | |
| alexchadin | hi | 10:25 |
| *** vijaykc4 has quit IRC | 10:35 | |
| asettle | AJaeger: why is this taking it's sweet ass time? https://review.openstack.org/#/c/475697/ | 10:40 |
| asettle | alexchadin: hello :) | 10:40 |
| alexchadin | asettle: do we still need api-ref folder in root of project? | 10:40 |
| asettle | alexchadin: please see line 10: https://etherpad.openstack.org/p/doc-migration-tracking | 10:40 |
| asettle | And then lines 29 - 31 | 10:41 |
| alexchadin | asettle: okay, we didn't have api-ref in root, but when tried to submit this commit: https://review.openstack.org/#/c/481069/ there was an check gate error that watcher don't have api-ref folder | 10:43 |
| alexchadin | asettle: we already have api in doc/source/api, can we set a link to it somehow? | 10:44 |
| asettle | Lemme take a looksie :) | 10:44 |
| asettle | https://developer.openstack.org/api-ref/resource-optimization/ does not exist (404) | 10:45 |
| *** vijaykc4 has joined #openstack-doc | 10:45 | |
| alexchadin | asettle: yeap, cause we don't have api-ref in root folder | 10:46 |
| alexchadin | but we have api in doc/source/api | 10:46 |
| asettle | Have you have to removed the api-ref from your check and gate jobs? | 10:46 |
| openstackgerrit | Merged openstack/security-doc master: Fixes incorrect OpenSCAP link https://review.openstack.org/481652 | 10:49 |
| openstackgerrit | Alexandra Settle proposed openstack/security-doc master: Adds checklist item for keystone insecure_debug https://review.openstack.org/481671 | 10:49 |
| alexchadin | asettle: we didn't have api-ref in check and gate jobs | 10:50 |
| asettle | Hmm | 10:50 |
| asettle | I can't think of anything off the top of my head, simply because this api stuff has been a bit of a mess. Perhaps I'm misunderstanding, but can you not rename your api folder to api-ref? Also, seeing as you don't have 'api-ref' why have you set it to true? | 10:52 |
| asettle | Because you don't have an api-ref, you have an api | 10:52 |
| *** caoyuan has joined #openstack-doc | 10:53 | |
| openstackgerrit | Merged openstack/security-doc master: Adds checklist item for keystone insecure_debug https://review.openstack.org/481671 | 10:59 |
| *** vijaykc4 has quit IRC | 11:01 | |
| openstackgerrit | Merged openstack/openstack-manuals master: remove link to networking guide from draft doc list https://review.openstack.org/481649 | 11:04 |
| openstackgerrit | Merged openstack/openstack-manuals master: show which template renders a given page https://review.openstack.org/481871 | 11:04 |
| AJaeger | asettle: I think it should be api - but let's discus with dhellmann | 11:04 |
| AJaeger | asettle: https://review.openstack.org/#/c/475227/1 needs to merge fist | 11:05 |
| asettle | AJaeger: ah. But there's no dependency on it? | 11:05 |
| AJaeger | asettle: stacked on top of it | 11:07 |
| AJaeger | "Related changes" | 11:08 |
| asettle | Ah, of course, thank you. | 11:09 |
| asettle | I always forget that | 11:09 |
| *** alexchadin has quit IRC | 11:10 | |
| *** caoyuan has quit IRC | 11:16 | |
| robcresswell | asettle: What's the best way to mark a setting deprecated in docs? | 11:23 |
| robcresswell | Is there a magic tag / syntax? | 11:23 |
| asettle | robcresswell: good question. I don't actually know. AJaeger do we have magic stuff? | 11:24 |
| asettle | We tend to do a bit of "This is deprecated as of RELEASE" | 11:24 |
| *** vijaykc4 has joined #openstack-doc | 11:24 | |
| *** edmondsw has joined #openstack-doc | 11:25 | |
| *** edmondsw has quit IRC | 11:25 | |
| *** edmondsw has joined #openstack-doc | 11:25 | |
| AJaeger | asettle: agreed ^ | 11:38 |
| asettle | Okay, no magic. | 11:38 |
| asettle | Maybe we should magic that.. | 11:38 |
| asettle | AJaeger: https://review.openstack.org/#/c/481110 merged, so I'm going to pull WIP of the deletion patches | 11:40 |
| asettle | https://review.openstack.org/481090 | 11:40 |
| asettle | https://review.openstack.org/481092 | 11:40 |
| *** vijaykc4 has quit IRC | 11:41 | |
| *** vijaykc4 has joined #openstack-doc | 11:41 | |
| robcresswell | asettle, AJaeger: A little googling says Sphinx has .. deprecated:: :D Although its not really styled by the docs theme | 11:44 |
| asettle | Damn that docs theme | 11:45 |
| robcresswell | Neither is .. versionadded::, its just plain text | 11:45 |
| asettle | You could... add it... to the docs theme | 11:45 |
| robcresswell | Sure | 11:45 |
| asettle | :D | 11:45 |
| AJaeger | asettle: for cli-reference, we have no solution yet - so for that one it's too early to go forward, isn't it? | 11:45 |
| asettle | AJaeger: what do you mean we have no solution? As in, we haven't moved it to the pythonclient? | 11:45 |
| asettle | Also, don't we still have the tag that is before-migration? | 11:46 |
| asettle | So we can still access everything? | 11:46 |
| AJaeger | asettle: docs.openstack.org/cli-reference will be empty, won't it? | 11:46 |
| AJaeger | asettle: we can - but our users not. The guide will be *removed* once your change merges! | 11:46 |
| asettle | AJaeger: oh, ha. Yes. Hm. \ | 11:46 |
| asettle | I'll put the -w back on the cli ref | 11:46 |
| AJaeger | thanks | 11:47 |
| asettle | I'll think some more about that cli ref | 11:47 |
| AJaeger | Sorry, no time for more work right now - I'm busy with some other stuff for the next hours... | 11:47 |
| asettle | No problem, you do what you gotta do :) | 11:47 |
| AJaeger | ;) | 11:48 |
| *** caoyuan has joined #openstack-doc | 11:52 | |
| *** thorst has joined #openstack-doc | 11:53 | |
| *** pkovar has joined #openstack-doc | 12:02 | |
| *** d0ugal has joined #openstack-doc | 12:04 | |
| *** d0ugal has quit IRC | 12:04 | |
| *** d0ugal has joined #openstack-doc | 12:04 | |
| *** d0ugal has quit IRC | 12:12 | |
| *** fragatina has joined #openstack-doc | 12:17 | |
| openstackgerrit | Alexander Chadin proposed openstack/openstack-manuals master: Enable install guide for Watcher https://review.openstack.org/481069 | 12:19 |
| *** caoyuan has quit IRC | 12:20 | |
| *** fragatina has quit IRC | 12:22 | |
| *** alexchadin has joined #openstack-doc | 12:25 | |
| *** caoyuan has joined #openstack-doc | 12:26 | |
| *** dmacpher has joined #openstack-doc | 12:35 | |
| alexchadin | asettle: could you please review it? https://review.openstack.org/#/c/481069/ | 12:35 |
| asettle | alexchadin: gotcha | 12:36 |
| asettle | yeah that built, it was the 'true' before. Which, it viewed you as not having. | 12:36 |
| alexchadin | asettle: yeap, but I still don't know what to do with it :) actually, we have api-ref, but it's called api and placed in doc/source as new doc standards require it | 12:39 |
| asettle | Yeah, so, as AJaeger mentioned, I think you are right in having an api rather than api-ref. But it is looking for 'api-ref' rather than api. Hopefully when dhellmann comes in he can shed some light here | 12:40 |
| alexchadin | asettle: I will read log if he comes and I am not here | 12:42 |
| asettle | alexchadin: no problem, i'll update the etherpad too | 12:42 |
| *** rbowen has joined #openstack-doc | 12:48 | |
| *** d0ugal has joined #openstack-doc | 12:54 | |
| *** d0ugal has quit IRC | 12:54 | |
| *** d0ugal has joined #openstack-doc | 12:54 | |
| *** d0ugal has quit IRC | 12:59 | |
| openstackgerrit | Merged openstack/openstack-manuals master: Enable install guide for Watcher https://review.openstack.org/481069 | 13:01 |
| *** catintheroof has joined #openstack-doc | 13:04 | |
| *** caoyuan has quit IRC | 13:07 | |
| *** d0ugal has joined #openstack-doc | 13:07 | |
| *** egallen has joined #openstack-doc | 13:14 | |
| alexchadin | asettle: well, since install guide is merged, how can we add link to watcher? I see here https://github.com/openstack/openstack-manuals/blob/master/www/project-install-guide/ocata/rdo-services.html that project should have ocata series | 13:21 |
| *** dustins has joined #openstack-doc | 13:25 | |
| *** donghao has joined #openstack-doc | 13:31 | |
| *** belmorei_ has joined #openstack-doc | 13:32 | |
| *** belmoreira has quit IRC | 13:32 | |
| stephenfin | dhellmann, mordred: I've been playing around with Sphinx trying to find a way to make https://review.openstack.org/#/c/481676/ an extension | 13:41 |
| stephenfin | Sorry - https://review.openstack.org/#/c/481674/ | 13:42 |
| stephenfin | mordred was dead right in his comment that "the initial sphinx constructor fails when project and version are missing so it doesn't make it as far as extensions" :( | 13:43 |
| stephenfin | The earliest "event" we can hook into is 'builder-inited', which comes way too late in the process, so I went adding a 'config-inited' event that we could use in Sphinx 1.7 or whatnot | 13:44 |
| stephenfin | but then I thought, "this is silly. Why don't readthedocs.org" have this issue | 13:44 |
| stephenfin | and it's because they store config _outside_ of conf.py, and simply pass it in as sphinx-build flags | 13:45 |
| stephenfin | which is something we can also do with the setuptools command (build_sphinx) | 13:45 |
| *** caoyuan has joined #openstack-doc | 13:47 | |
| stephenfin | so, my thought is that we modify the doc build jobs to start passing in these flags and completely override ignore whatever's in conf.py | 13:47 |
| stephenfin | I'm not sure if we already thought of this, but it's minimal effort and doesn't require rolling anything out to the projects now or ever. We just tell folks to set 'project', 'version' and 'copyright' to something generic _if they want to_ | 13:47 |
| stephenfin | also, I just realized I posted this all in #openstack-docs instead of #openstack-infra, where I think we had the "deprecate pbr's 'build_sphinx'" discussion Friday. Sorry | 13:48 |
| stephenfin | but in any case, let me know what you think dhellmann, mordred | 13:48 |
| *** vijaykc4 has quit IRC | 13:50 | |
| csatari | dhellmann, AJaeger: Where are the "other cookiecutter templates" mentioned in https://review.openstack.org/#/c/481642/ ? | 13:56 |
| AJaeger | csatari: openstack-dev/cookiecutter openstack/ui-cookiecutter | 13:58 |
| AJaeger | The other cookiecutter templates are not relevant here. | 13:59 |
| AJaeger | check https://git.openstack.org/cgit for list of all repos | 13:59 |
| *** xiaofandh12 has joined #openstack-doc | 14:01 | |
| alexchadin | AJaeger: hi | 14:02 |
| *** d0ugal has quit IRC | 14:03 | |
| *** donghao has quit IRC | 14:04 | |
| *** gouthamr has joined #openstack-doc | 14:10 | |
| csatari | AJaeger> Thanks. I think only openstack/cookiecutter is affected. Not even openstack/ui-cookiecutter . | 14:12 |
| csatari | I rty to folrulate a mail about the deprecation of installguide-cookiecutter. | 14:13 |
| *** mriedem has joined #openstack-doc | 14:15 | |
| *** fragatina has joined #openstack-doc | 14:19 | |
| *** fragatina has quit IRC | 14:24 | |
| *** chlong_ has joined #openstack-doc | 14:24 | |
| *** fragatina has joined #openstack-doc | 14:24 | |
| *** alexchadin has quit IRC | 14:25 | |
| *** caoyuan_ has joined #openstack-doc | 14:35 | |
| mordred | stephenfin: I think the biggest issue is that we need a tool (could be a command-line tool pbr provides) that can call sphinx-build with the right project version and copyright options | 14:35 |
| mordred | stephenfin: and that, I think, gets us back into the similar place of having the 'normal' sphinx-build command not work | 14:35 |
| mordred | stephenfin: I like, if we can, the possibility of having people able to just run sphinx-build if they are people who know how that works and have that not do anything worng | 14:36 |
| *** fragatina has quit IRC | 14:36 | |
| *** caoyuan has quit IRC | 14:37 | |
| *** belmorei_ has quit IRC | 14:41 | |
| *** ianychoi has quit IRC | 14:44 | |
| *** annegentle has joined #openstack-doc | 14:45 | |
| *** rcernin has quit IRC | 14:57 | |
| *** xiaofandh12 has quit IRC | 15:02 | |
| stephenfin | mordred: Yeah, good point. I was thinking more along the lines of setting the configuration options to dummy values though | 15:07 |
| mordred | stephenfin: I worry that that will cause confusion for people if the values are in the conf.py file and then they do not end up in the published docs - that people would submit a patch to change something and then be confused why it didn't take effect | 15:08 |
| mordred | stephenfin: however - I'm not _opposed_ to that direction - I think it's certainly a viable option | 15:09 |
| stephenfin | mordred: Ditto for the new configuration option (from my perspective). I'm just looking around at how things are done elsewhere for inspiration right now | 15:11 |
| dhellmann | asettle, AJaeger, alexchadin: the has_api_ref flag looks for the separately published API guide. I planned to change that to deal with in-tree API guides after we tell project to move that content. | 15:12 |
| AJaeger | dhellmann: "API reference" instead of "API guide" I hope ;) | 15:14 |
| dhellmann | AJaeger : both, either, whatever -- moving any API docs and linking to them is future work | 15:15 |
| dhellmann | stephenfin : passing values from the docs jobs may make sense, but I think I'd have to see the details more clearly. Could you post a follow-up to the ML thread about that with some examples? | 15:15 |
| stephenfin | dhellmann: Sure, I'll put that together now | 15:16 |
| *** chlong_ has quit IRC | 15:16 | |
| dhellmann | stephenfin : also consider that maybe this isn't an extension but a cantrip that we just put in the conf.py to get the values from pbr so they are consistent. | 15:17 |
| mordred | dhellmann, stephenfin: for the jobs to pass the data in, we'll need *something* to be able to produce the data to pull in. I believe that isn't code we'd want to live directly in the jobs themselves | 15:17 |
| dhellmann | right | 15:17 |
| stephenfin | dhellmann: cantrip? | 15:17 |
| mordred | dhellmann: like this: https://review.openstack.org/#/c/481674/2/doc/source/conf.py ? | 15:17 |
| dhellmann | mordred : sort uf, but ew, setting globals like that? | 15:18 |
| dhellmann | what happened to project, release, version = ... | 15:18 |
| mordred | dhellmann: that's also possible with that patch | 15:18 |
| mordred | dhellmann: I made a get and a set | 15:18 |
| dhellmann | stephenfin : https://en.wikipedia.org/wiki/Cantrip | 15:18 |
| dhellmann | stephenfin : s/cantrip/pattern or boilerplate or some other term for "put the same code in each project" | 15:19 |
| mordred | dhellmann: but I got a little more aggressive in https://review.openstack.org/#/c/481677 and the set_ wound up being helpful | 15:19 |
| mordred | dhellmann: in any case - I broke it out into a series so we could think about relative merits and whatnot | 15:20 |
| dhellmann | ok. I'll put those in my review queue | 15:20 |
| AJaeger | dhellmann: so, for a first step for alexchadin: They can move api-ref to doc/source/api, we link to that from our manual overview page - and later we autogenerate it. AGreed? | 15:20 |
| *** d0ugal has joined #openstack-doc | 15:20 | |
| *** d0ugal has quit IRC | 15:20 | |
| *** d0ugal has joined #openstack-doc | 15:20 | |
| dhellmann | AJaeger : how about adding a "has_in_tree_api_docs" flag instead? | 15:21 |
| dhellmann | then as projects move their API guides, one step is to change which flag they have set to link to the new publish location | 15:21 |
| AJaeger | dhellmann: would work as well | 15:21 |
| AJaeger | dhellmann: good idea | 15:21 |
| dhellmann | moving all of those guides is going to break the links on developer.o.o and I haven't had time to figure out that site build yet so I didn't want anything moving, but if these are already in-tree it's fine | 15:21 |
| *** fragatina has joined #openstack-doc | 15:26 | |
| *** chlong_ has joined #openstack-doc | 15:30 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: link to in-tree API documentation https://review.openstack.org/482188 | 15:38 |
| dhellmann | AJaeger, alexchadin: ^^ | 15:38 |
| *** d0ugal has quit IRC | 15:56 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove config ref from openstack-manuals https://review.openstack.org/481090 | 15:59 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: treat redirect errors as invalid links https://review.openstack.org/481109 | 15:59 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add a page listing all configuration reference guides https://review.openstack.org/481110 | 15:59 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove links to cli-reference from template pages https://review.openstack.org/481096 | 15:59 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove the cli-ref from openstack-manuals https://review.openstack.org/481092 | 15:59 |
| *** cathrichardson has joined #openstack-doc | 15:59 | |
| *** cathrich_ has quit IRC | 16:02 | |
| *** chlong_ has quit IRC | 16:06 | |
| *** vijaykc4 has joined #openstack-doc | 16:07 | |
| *** vijaykc4 has quit IRC | 16:11 | |
| *** annegentle has quit IRC | 16:12 | |
| *** caoyuan_ has quit IRC | 16:20 | |
| *** chlong_ has joined #openstack-doc | 16:21 | |
| *** fragatina has quit IRC | 16:21 | |
| *** dmacpher has quit IRC | 16:22 | |
| robcresswell | asettle: How does one go about patching the docs theme? Is it a standard gerrit process? | 16:28 |
| robcresswell | asettle: Would just like to add support for a few of the notes that appear to be missing, like versionadded, deprecated, etc. | 16:29 |
| mugsie | robcresswell: it is | 16:29 |
| robcresswell | \o/ neat | 16:29 |
| mugsie | https://github.com/openstack/openstackdocstheme | 16:29 |
| robcresswell | mugsie: Thanks | 16:30 |
| mugsie | np | 16:30 |
| *** annegentle has joined #openstack-doc | 16:34 | |
| robcresswell | Uh, another more general question, why are we using non-minified CSS for everything? | 16:34 |
| robcresswell | Seems like a pretty nice way of making the doc site use more bandwidth and load slower :/ | 16:34 |
| robcresswell | non-minified JS too :) | 16:35 |
| mugsie | there was a commit for that somewhere | 16:36 |
| robcresswell | Oh, I'll take a look | 16:36 |
| mugsie | debian freaked out a little bit I think | 16:36 |
| robcresswell | -.- | 16:36 |
| robcresswell | I wonder if we could just put both in the theme and that would make them happy | 16:37 |
| robcresswell | but only serve the minified version | 16:37 |
| mugsie | yeah - we would have to make the release job do the minification - but that should be doable | 16:37 |
| robcresswell | Well, what I meant was, if we provide both files (min and original) as part of the theme, but only serve the .min file; I wonder if that would satisfy Debians requirements. | 16:38 |
| mugsie | yeah - it think that is allowed | 16:38 |
| *** chlong_ has quit IRC | 16:38 | |
| robcresswell | Ah, well thats trivial to do. I'll look at patching that when I've figured out how this all works. | 16:39 |
| AJaeger | asettle: could you +2a https://review.openstack.org/#/c/481110/ , please? | 16:41 |
| AJaeger | robcresswell: I'm happy to +2 ;) | 16:42 |
| *** fragatina has joined #openstack-doc | 16:42 | |
| AJaeger | another option to investigate is serving the theme JS from one location at our side - instead of making it part of each document. so, publish once to docs.o.o/common-js - and use that everywhere. for offline building, we might need to add some options to include the JS in that case. | 16:43 |
| robcresswell | I mean, ideally you'd run all the CSS through some sort of preprocessor to reduce all the nesting and then serve a single file | 16:45 |
| robcresswell | I dont know if its worth investing the time though, tbh. | 16:45 |
| robcresswell | The .min files is very easy to change though, and I wouldn't be surprised if it has quite a big impact on loading time / bandwidth (maybe 10 - 20%) | 16:46 |
| mugsie | robcresswell: yeah - someone needs to take the theme and make it more sphinx'y first though | 16:46 |
| mugsie | horizon does minification after install right? | 16:47 |
| mugsie | or does it do some in -infra / | 16:47 |
| mugsie | ?* | 16:47 |
| robcresswell | mugsie: Yeah, we run everything through a compressor | 16:48 |
| robcresswell | static sites like this would generally serve up one compressed css file and one compressed js file, but that requires building a toolchain around it | 16:48 |
| robcresswell | And I think the time involved there probably outweighs the gain :) | 16:49 |
| *** fragatina has quit IRC | 16:49 | |
| * mugsie wonders if there is a way to get sphinx to compress them | 16:49 | |
| *** pkovar has quit IRC | 16:50 | |
| mugsie | http://sakulstra.github.io/2015/04/18/asset_compression_in_tinkerer_and_sphinx.html might do it | 16:51 |
| robcresswell | mugsie: https://github.com/Kronuz/pyScss would probably be a bit more straightforward | 16:52 |
| mugsie | robcresswell: yeah but the advantage of ^ would be it would also compress css / js from other plugins / custom CSS included by projects | 16:52 |
| mugsie | but it would be more complex | 16:53 |
| robcresswell | huh, I hadn't actually realised anyone else was adding css on top of the base theme | 16:53 |
| mugsie | (sphinx plugins are great, once you get used to them, but before that they are a royal pain) | 16:53 |
| robcresswell | Yeah, I'm not familiar with them | 16:53 |
| mugsie | well, api-ref does, and designate does for a our driver matrix | 16:54 |
| mugsie | that all I know of | 16:54 |
| robcresswell | thats 2 already though, it could easily be more. | 16:54 |
| mugsie | (both of which are my fault to be fair) | 16:54 |
| * robcresswell shakes fist | 16:54 | |
| *** masaki has joined #openstack-doc | 16:55 | |
| mugsie | well api-ref was sdague first - I just compounded the issue :D | 16:55 |
| robcresswell | haha | 16:55 |
| openstackgerrit | Merged openstack/openstack-manuals master: remove config ref from openstack-manuals https://review.openstack.org/481090 | 16:55 |
| AJaeger | mugsie: is there anything to merge back to openstackdocstheme? | 16:55 |
| openstackgerrit | Merged openstack/openstack-manuals master: treat redirect errors as invalid links https://review.openstack.org/481109 | 16:55 |
| *** masaki has quit IRC | 16:55 | |
| mugsie | AJaeger: not really | 16:55 |
| mugsie | https://github.com/openstack/designate/blob/master/doc/ext/assets/support-matrix.css | 16:56 |
| mugsie | and https://github.com/openstack/designate/blob/master/doc/ext/assets/support-matrix.js to make it work | 16:56 |
| mugsie | wow - that was hacky code | 16:56 |
| annegentle | mugsie :) if you say so | 16:58 |
| AJaeger | dhellmann: if we merge https://review.openstack.org/#/c/481092 , docs.o.o/cli-reference will 404 - we will automatically delete it. Do you want to add some redirects? | 17:00 |
| AJaeger | annegentle: could you +2a https://review.openstack.org/#/c/481110/ , please? | 17:01 |
| annegentle | AJaeger looking | 17:01 |
| *** tesseract has quit IRC | 17:01 | |
| annegentle | AJaeger what's the draft/ story? | 17:03 |
| annegentle | AJaeger get /latest/ only? And use Gerrit for drafts? | 17:03 |
| dhellmann | AJaeger : I thought I had a redirect for that in one of the patches? maybe that was the series | 17:04 |
| robcresswell | mugsie: This is the kind of thing I wanted to add for the versionadded tag. Similar for deprecated and versionchanged. http://i.imgur.com/5pZHuSv.png | 17:06 |
| robcresswell | Clearly thats a silly example as its old, but you get the point | 17:06 |
| dhellmann | AJaeger : where should it redirect? maybe the python-openstackclient docs? | 17:07 |
| dhellmann | AJaeger : or the language-bindings page? | 17:07 |
| mugsie | robcresswell: yeah, makes sense | 17:08 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: redirect cli-reference to python-openstackclient https://review.openstack.org/482220 | 17:10 |
| *** fragatina has joined #openstack-doc | 17:15 | |
| *** fragatina has quit IRC | 17:15 | |
| *** fragatina has joined #openstack-doc | 17:17 | |
| *** fragatina has quit IRC | 17:18 | |
| *** fragatina has joined #openstack-doc | 17:18 | |
| *** yamamoto has quit IRC | 17:19 | |
| AJaeger | dhellmann: perhaps language-bindings - no good idea | 17:23 |
| AJaeger | annegentle: we published /draft/config-reference - and now have a new generated page that is currently not accessible | 17:24 |
| annegentle | AJaeger ok, so between releases, no more /draft/config-reference, correct? | 17:24 |
| AJaeger | annegentle: correct. We removed config-reference from openstack-manuals | 17:25 |
| AJaeger | its now all in project repos | 17:25 |
| annegentle | AJaeger got it. | 17:26 |
| annegentle | thanks! | 17:26 |
| robcresswell | re: deprecated, versionadded, something like this? http://i.imgur.com/UzjKNDU.png | 17:31 |
| robcresswell | asettle: ^^ | 17:31 |
| *** dustins has quit IRC | 17:33 | |
| annegentle | robcresswell fwiw I like it, esp. if you can link to the "use this instead" | 17:34 |
| annegentle | robcresswell I always get confused on "Deprecated since" wording | 17:35 |
| annegentle | robcresswell but if that's what it says now, keep it! | 17:35 |
| annegentle | robcresswell (thinking: New in, Deprecated in" | 17:35 |
| annegentle | keep the "in" for consistency, is all. | 17:35 |
| robcresswell | Yeah, thats just the default. The actual content in the doc atm is .. deprecated:: 9.0.0(Mitaka) <other text> | 17:36 |
| *** tosky has quit IRC | 17:37 | |
| annegentle | robcresswell oh, funny. ok | 17:38 |
| annegentle | robcresswell still doesn't answer, "Can I use it in Mitaka?" LOL | 17:38 |
| robcresswell | Ah I see what you mean | 17:40 |
| robcresswell | I guess that's a wording thing? I take deprecated to mean that its still there. When its removed it wouldn't be documented any more. | 17:40 |
| annegentle | robcresswell yeah... it is... I'll let asettle take a look too. Where does that actual "since" word live then? | 17:44 |
| mugsie | robcresswell: I like that style for the rendering - I will stay out of any wording disscussions though :) | 17:45 |
| annegentle | mugsie :) | 17:45 |
| openstackgerrit | Merged openstack/openstack-manuals master: add a page listing all configuration reference guides https://review.openstack.org/481110 | 17:52 |
| openstackgerrit | Doug Hellmann proposed openstack/openstackdocstheme master: show the current project name and version in navigation link https://review.openstack.org/482230 | 17:54 |
| *** annegentle has quit IRC | 17:56 | |
| *** annegentle has joined #openstack-doc | 17:59 | |
| robcresswell | annegentle: no idea, I'd not looked at a theme until about half an hour ago, so no idea how they work | 17:59 |
| annegentle | robcresswell ok, no worries | 17:59 |
| openstackgerrit | Major Hayden proposed openstack/security-doc master: Rework the 'node hardening' section https://review.openstack.org/482231 | 18:00 |
| *** emagana has joined #openstack-doc | 18:00 | |
| *** tosky has joined #openstack-doc | 18:01 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: link to in-tree API documentation https://review.openstack.org/482188 | 18:15 |
| mugsie | annegentle: it looks like the wording is built into sphinx | 18:17 |
| annegentle | mugsie ohhh then probably leave well enough alone :) | 18:17 |
| mugsie | :) | 18:17 |
| *** yamamoto has joined #openstack-doc | 18:19 | |
| *** yamamoto has quit IRC | 18:27 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: use the governance data to build the redirect list for /latest/ https://review.openstack.org/481172 | 18:28 |
| openstackgerrit | Merged openstack/openstackdocstheme master: show the current project name and version in navigation link https://review.openstack.org/482230 | 18:33 |
| *** dustins has joined #openstack-doc | 18:55 | |
| *** annegentle has quit IRC | 19:03 | |
| notmyname | is the resulting conf.py in the unified docs tree supposed to have tex/manpage/pdf entries? | 19:37 |
| notmyname | are those used anywhere? | 19:37 |
| *** annegentle has joined #openstack-doc | 19:42 | |
| *** cathrichardson has quit IRC | 19:49 | |
| *** cathrichardson has joined #openstack-doc | 19:49 | |
| *** edmondsw_ has joined #openstack-doc | 19:53 | |
| *** edmondsw has quit IRC | 19:56 | |
| *** edmondsw has joined #openstack-doc | 19:57 | |
| *** d0ugal has joined #openstack-doc | 19:57 | |
| *** edmondsw_ has quit IRC | 19:59 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add libraries to list of configuration reference guides https://review.openstack.org/482263 | 20:01 |
| openstackgerrit | Rob Cresswell proposed openstack/openstackdocstheme master: Add support for versionadded and deprecated https://review.openstack.org/482265 | 20:07 |
| openstackgerrit | Rob Cresswell proposed openstack/openstackdocstheme master: Add support for versionadded and deprecated https://review.openstack.org/482265 | 20:09 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add validation requiring clients to have a description value https://review.openstack.org/482275 | 20:18 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: shorten the shade description https://review.openstack.org/482276 | 20:18 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: sort libraries by service description https://review.openstack.org/482277 | 20:19 |
| robcresswell | AJaeger, asettle, mugsie: I pushed a patch with a rough implementation and an alternative (w/ screenshots) to the theme repo. | 20:20 |
| robcresswell | Just in case you were interested. | 20:20 |
| robcresswell | Its just a WIP for now. | 20:21 |
| annegentle | hey robcresswell - what's the RST markup for those admonitions again? | 20:32 |
| annegentle | I'll add it to the demo docs in the repo | 20:32 |
| robcresswell | annegentle: ..versionadded::, ..versionchanged::, ..deprecated:: | 20:33 |
| annegentle | robcresswell ok thanks | 20:33 |
| robcresswell | annegentle: I just pinched them from http://www.sphinx-doc.org/en/stable/markup/para.html | 20:33 |
| *** nicolasbock has quit IRC | 20:34 | |
| mugsie | robcresswell: cool, will have a look in a few mins | 20:41 |
| robcresswell | mugsie: Definitely no rush! Whenever is good, just thought I'd point it out. | 20:41 |
| mugsie | Doing this takes me away from looking at failed ci runs | 20:42 |
| mugsie | :D | 20:42 |
| *** thorst has quit IRC | 20:42 | |
| *** thorst has joined #openstack-doc | 20:45 | |
| openstackgerrit | Anne Gentle proposed openstack/openstackdocstheme master: Add support for versionadded and deprecated https://review.openstack.org/482265 | 20:46 |
| annegentle | robcresswell hm, review my RST, doesn't seem to pick it up, and I'm not sure why? | 20:47 |
| annegentle | Oh am I missing a space? Trying again | 20:47 |
| *** thorst has quit IRC | 20:49 | |
| openstackgerrit | Anne Gentle proposed openstack/openstackdocstheme master: Add support for versionadded and deprecated https://review.openstack.org/482265 | 20:49 |
| annegentle | robcresswell yeah, needed a space, but "Changed in" doesn't seem to be giving styling. | 20:49 |
| *** d0ugal has quit IRC | 20:52 | |
| *** catintheroof has quit IRC | 20:53 | |
| *** MeganR has joined #openstack-doc | 20:55 | |
| *** thorst has joined #openstack-doc | 21:00 | |
| *** annegentle has quit IRC | 21:01 | |
| *** annegentle has joined #openstack-doc | 21:01 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add flag to www-generator to look for links to enable https://review.openstack.org/482313 | 21:02 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add flags for a bunch of missing guides https://review.openstack.org/482314 | 21:02 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add a new landing page to list all admin guides https://review.openstack.org/482315 | 21:02 |
| *** fragatina has quit IRC | 21:18 | |
| *** fragatina has joined #openstack-doc | 21:19 | |
| *** tonytan4ever has joined #openstack-doc | 21:19 | |
| *** fragatin_ has joined #openstack-doc | 21:21 | |
| *** fragatina has quit IRC | 21:25 | |
| *** fragatin_ has quit IRC | 21:25 | |
| *** fragatina has joined #openstack-doc | 21:25 | |
| robcresswell | annegentle: Thanks for updating the patch! I'll take a look again in the morning. Any thought on which version of the screenshots is better? | 21:26 |
| *** oanson has quit IRC | 21:28 | |
| *** oanson has joined #openstack-doc | 21:29 | |
| *** MeganR has quit IRC | 22:02 | |
| *** thorst has quit IRC | 22:02 | |
| *** dustins has quit IRC | 22:03 | |
| *** deep-book-gk_ has joined #openstack-doc | 22:26 | |
| *** deep-book-gk_ has left #openstack-doc | 22:29 | |
| *** suyog has joined #openstack-doc | 22:29 | |
| *** emagana has quit IRC | 22:36 | |
| *** emagana has joined #openstack-doc | 22:37 | |
| *** emagana has quit IRC | 22:42 | |
| *** catintheroof has joined #openstack-doc | 22:43 | |
| notmyname | since the new docs layout has the existing dev docs moving to the contributors/ subdir, is there a plan for dealing with the broken links this will create? | 22:43 |
| notmyname | is the existing root of the published docs going to point to the new contributing/ subdir? (ie nothing breaks, but the sibling subdirs don't get referenced) | 22:44 |
| notmyname | my understanding is that stuff that's currently in doc/source/ is to be moved to doc/source/contributor/. which is fine, i guess, but what about existing links? eg https://docs.openstack.org/swift/latest/ring.html | 22:50 |
| notmyname | if we move it, that doc will be at https://docs.openstack.org/swift/latest/contributor/index.html | 22:51 |
| *** egallen has quit IRC | 22:52 | |
| notmyname | so is the plan to rip the band-aide off and redo everything now? or is there going to be a 404 redirect to contributor/? or is the plan for /{project}/latest/ to only be the stuff under contributor/ and the whole docs may or may not have a root somewhere else? | 22:54 |
| *** egallen has joined #openstack-doc | 23:02 | |
| *** egallen has quit IRC | 23:02 | |
| openstackgerrit | Anne Gentle proposed openstack/openstackdocstheme master: Add support for versionadded and deprecated https://review.openstack.org/482265 | 23:05 |
| openstackgerrit | Anne Gentle proposed openstack/openstackdocstheme master: Add support for versionadded and deprecated https://review.openstack.org/482265 | 23:05 |
| *** fragatin_ has joined #openstack-doc | 23:07 | |
| *** fragatina has quit IRC | 23:10 | |
| *** fragatin_ has quit IRC | 23:14 | |
| *** fragatina has joined #openstack-doc | 23:15 | |
| notmyname | hmm... based on the 404 page, broken links are expected | 23:16 |
| *** thorst has joined #openstack-doc | 23:17 | |
| notmyname | (although I'm not sure a link to the doc migration spec is helpful or friendly to those who actually need to use the docs) | 23:17 |
| notmyname | is it possible to have my own 404 page defined. eg doc/source/404error.rst or something like that? | 23:18 |
| notmyname | or at least a link back up to the project? eg https://docs.openstack.org/swift/latest/foo has a link to https://docs.openstack.org/swift/latest/ | 23:18 |
| notmyname | or https://docs.openstack.org/swift/ | 23:18 |
| *** thorst has quit IRC | 23:21 | |
| *** charcol has joined #openstack-doc | 23:23 | |
| *** edmondsw has quit IRC | 23:40 | |
| *** amotoki is now known as amotoki_away | 23:43 | |
| *** annegentle has quit IRC | 23:45 | |
| *** thorst has joined #openstack-doc | 23:57 | |
| *** oanson has quit IRC | 23:59 | |
| *** catintheroof has quit IRC | 23:59 | |
Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!
