| *** yangyapeng has joined #openstack-doc | 00:00 | |
| *** masaki has joined #openstack-doc | 00:02 | |
| *** yangyapeng has quit IRC | 00:05 | |
| *** yamamoto has joined #openstack-doc | 00:08 | |
| *** yangyapeng has joined #openstack-doc | 00:09 | |
| *** gmann has quit IRC | 00:14 | |
| *** gmann has joined #openstack-doc | 00:14 | |
| *** yangyapeng has quit IRC | 00:20 | |
| *** lbragsta_ has quit IRC | 00:28 | |
| *** thorst has joined #openstack-doc | 00:31 | |
| *** catintheroof has joined #openstack-doc | 00:33 | |
| *** thorst has quit IRC | 00:36 | |
| *** gouthamr has joined #openstack-doc | 01:01 | |
| *** mriedem has joined #openstack-doc | 01:03 | |
| *** thorst has joined #openstack-doc | 01:03 | |
| *** thorst has quit IRC | 01:03 | |
| *** masaki_ has joined #openstack-doc | 01:16 | |
| *** masaki has quit IRC | 01:16 | |
| *** masaki_ has quit IRC | 01:16 | |
| *** masaki has joined #openstack-doc | 01:17 | |
| *** masaki is now known as masaki|01894012 | 01:21 | |
| *** phuongnh has joined #openstack-doc | 01:21 | |
| *** catintheroof has quit IRC | 02:22 | |
| *** mriedem has quit IRC | 02:43 | |
| *** lbragsta_ has joined #openstack-doc | 02:48 | |
| *** gouthamr has quit IRC | 02:49 | |
| *** thorst has joined #openstack-doc | 03:04 | |
| *** thorst has quit IRC | 03:10 | |
| *** mtreinish has quit IRC | 03:14 | |
| *** mtreinish has joined #openstack-doc | 03:20 | |
| *** vijaykc4 has joined #openstack-doc | 03:21 | |
| *** vijaykc4 has quit IRC | 03:24 | |
| *** fragatina has quit IRC | 03:38 | |
| *** fragatina has joined #openstack-doc | 03:39 | |
| *** lbragsta_ has quit IRC | 04:02 | |
| *** lbragsta_ has joined #openstack-doc | 04:04 | |
| *** fragatina has quit IRC | 04:31 | |
| *** fragatina has joined #openstack-doc | 04:32 | |
| *** lbragsta_ has quit IRC | 04:35 | |
| *** Dinesh_Bhor has joined #openstack-doc | 04:56 | |
| *** thorst has joined #openstack-doc | 05:05 | |
| *** thorst has quit IRC | 05:10 | |
| AJaeger | asettle: we need https://review.openstack.org/486293 to merge to fix all the build failures - ceilometer's install guide had a publishing problem. | 06:14 |
|---|---|---|
| AJaeger | once that is merged, we can recheck the most recent submissions | 06:14 |
| *** rcernin has joined #openstack-doc | 06:23 | |
| *** thorst has joined #openstack-doc | 06:27 | |
| *** andreas_s has joined #openstack-doc | 06:27 | |
| *** thorst has quit IRC | 06:31 | |
| *** yamamoto has quit IRC | 06:34 | |
| *** suyog has quit IRC | 06:52 | |
| *** AJaeger has quit IRC | 07:00 | |
| *** AJaeger has joined #openstack-doc | 07:01 | |
| *** nicolasbock has joined #openstack-doc | 07:03 | |
| *** charcol has quit IRC | 07:25 | |
| *** belmoreira has joined #openstack-doc | 07:39 | |
| *** yamamoto has joined #openstack-doc | 07:45 | |
| *** alexchadin has joined #openstack-doc | 07:54 | |
| *** egallen has joined #openstack-doc | 08:21 | |
| *** thorst has joined #openstack-doc | 08:27 | |
| *** s-shiono_ has quit IRC | 08:32 | |
| *** thorst has quit IRC | 08:32 | |
| asettle | AJaeger: np | 08:35 |
| *** warlord77 has joined #openstack-doc | 08:37 | |
| openstackgerrit | Merged openstack/openstack-manuals master: [www] Update project-data https://review.openstack.org/486293 | 08:42 |
| warlord77 | asettle, hi | 08:50 |
| asettle | Morning warlord77 :) | 08:53 |
| *** masaki|01894012 has quit IRC | 09:02 | |
| *** warlord77 has quit IRC | 09:02 | |
| *** yamamoto has quit IRC | 09:02 | |
| *** w77 has joined #openstack-doc | 09:14 | |
| openstackgerrit | Hangdong Zhang proposed openstack/openstackdocstheme master: Update 2 documentation URLs according to doc migration https://review.openstack.org/486533 | 09:14 |
| *** yamamoto has joined #openstack-doc | 09:15 | |
| *** pblaho has joined #openstack-doc | 09:21 | |
| openstackgerrit | Andreas Jaeger proposed openstack/openstack-manuals master: Explain new project specific doc layout https://review.openstack.org/486368 | 09:47 |
| *** yamamoto has quit IRC | 09:47 | |
| *** yamamoto has joined #openstack-doc | 10:02 | |
| *** yamamoto has quit IRC | 10:02 | |
| w77 | asettle, whats d status of migration is it done ? | 10:07 |
| *** w77 is now known as warlord77 | 10:07 | |
| asettle | warlord77: as per our previous conversation, the migration will be completed in due time. On our side, I believe we have done everything we have been required to do. But we have a backlog of items ready for hte Queens release. | 10:08 |
| asettle | All documentation has not been migrated as it is the duty of hte project teams to ensure the documentation is moved. | 10:08 |
| asettle | You can view the project status here: https://doughellmann.com/doc-migration/ | 10:08 |
| asettle | Here is the tracking etherpad: https://etherpad.openstack.org/p/doc-migration-tracking | 10:08 |
| asettle | And here is our backlog of items for Queens: https://etherpad.openstack.org/p/doc-future-problems | 10:08 |
| asettle | If you are unsure of the releases and their schedules, you can view that all here: https://releases.openstack.org/ | 10:09 |
| asettle | We are currently in the Pike release | 10:09 |
| *** pkovar has joined #openstack-doc | 10:11 | |
| robcresswell | asettle: Do you have a link to the original spec btw? Wanted to reference it for something | 10:12 |
| asettle | Yep, uno momento | 10:12 |
| asettle | http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html | 10:12 |
| robcresswell | thanks asettle | 10:13 |
| asettle | No sweat :) | 10:13 |
| *** thorst has joined #openstack-doc | 10:29 | |
| *** masaki has joined #openstack-doc | 10:29 | |
| *** yamamoto has joined #openstack-doc | 10:33 | |
| *** thorst has quit IRC | 10:33 | |
| *** egallen has quit IRC | 10:34 | |
| AJaeger | asettle: we have quite a few 404s for guides from docs.openstack.org - that needs to be handled now. | 10:36 |
| AJaeger | asettle, dhellmann I think we should merge the sitemap - and update again in a week or two: https://review.openstack.org/486350 | 10:37 |
| asettle | aspiers: yeah we really do. | 10:40 |
| asettle | AJaeger: is it the redirects page? | 10:40 |
| asettle | AJaeger: not aspiers* | 10:43 |
| * aspiers goes back to sleep | 10:47 | |
| *** phuongnh has quit IRC | 10:50 | |
| *** sambetts has joined #openstack-doc | 10:52 | |
| sambetts | Morning docs team, I have a question about the doc migration, is it expected that upgrade docs are part of the install guide or the admin guide? | 10:53 |
| asettle | sambetts: aw man y u ask the hard questions | 10:53 |
| asettle | So, I believe it should be admin | 10:53 |
| asettle | Previously that's where we've had upgrade docs - that, or in operator documentation. Which is under admin | 10:53 |
| asettle | Okay, I've settled it with myself (har har har) - we're going with admin | 10:54 |
| sambetts | :-P cool I'll quote you on that ;) | 10:54 |
| AJaeger | sambetts, asettle, dhellmann : Let'S figure out - and document ;) - update specs and also https://review.openstack.org/#/c/486368/ | 10:54 |
| asettle | "how to run or operate the software." | 10:55 |
| asettle | That pretty much is upgrades | 10:55 |
| * AJaeger updates 486368 | 10:56 | |
| openstackgerrit | Andreas Jaeger proposed openstack/openstack-manuals master: Explain new project specific doc layout https://review.openstack.org/486368 | 10:57 |
| AJaeger | asettle, sambetts, dhellmann ^ | 10:57 |
| sambetts | Is there a plan to have a common layout for project's doc/source/index.rst? | 10:58 |
| asettle | Thanks AJaeger :) | 10:58 |
| asettle | sambetts: nope, that's up to you. As long as it is within the confines of the structure. We have recommendations, if you would like | 10:59 |
| sambetts | asettle: Yeah I'd like to see that, I personally think this layout https://docs.openstack.org/horizon/latest/ is the nicest I've seen so far | 11:00 |
| asettle | robcresswell: your shit is real popular man | 11:00 |
| asettle | I worked with the OSA team and this is how they did theirs: http://docs.openstack.org/developer/openstack-ansible/ | 11:01 |
| robcresswell | What can I say | 11:01 |
| asettle | Another good one is keystone: https://docs.openstack.org/keystone/latest/ | 11:01 |
| asettle | robcresswell: nothing | 11:01 |
| robcresswell | :( | 11:01 |
| asettle | robcresswell: aw okay I didn't mean it | 11:01 |
| robcresswell | You are too sassy today | 11:01 |
| robcresswell | I prefer you when you are less sassy | 11:01 |
| asettle | robcresswell: aw :( | 11:02 |
| asettle | sambetts: I'm working with stephenfin and doing the nova docs too. We're making that a pretty mess: https://review.openstack.org/#/c/478485/ | 11:02 |
| sambetts | thats quite similar, I'm waiting for jenkins to render it, but I have POC for the ironic-inspector docs here https://review.openstack.org/#/c/486555 which takes a leave straight of the horzion book | 11:06 |
| sambetts | is there expectation for inclusion of things like the project logos on the landing page, that seems like it would be a good thing to have# | 11:06 |
| sambetts | maybe it could be part of the openstackdoctheme (if it isn't already) | 11:07 |
| *** Dinesh_Bhor has quit IRC | 11:07 | |
| asettle | sambetts: there's no expectation. You're welcome to alter that as you please. We included ours for the contributor guide | 11:08 |
| asettle | The idea is that the theme is what is unified, at the moment. | 11:08 |
| asettle | We don't really want to jam our thoughts on formatting down peoples throats. | 11:08 |
| asettle | Baby steps ;) | 11:08 |
| sambetts | oh man but force feeding is the best kind XD | 11:09 |
| robcresswell | haha | 11:11 |
| sambetts | honestly though, working through the ironic project docs we're struggling to know what things should look like, at least an example/recomended but not mandatory project landing page would be nice | 11:12 |
| robcresswell | The spec is the best reference really | 11:13 |
| asettle | sambetts: okay, good feedback :) as robcresswell said, we have the spec. But if you think perhaps just a 'hey this is a good style' would help, I can talk to the gang about knocking something up that isn't comparing project to project | 11:13 |
| robcresswell | I've just been telling people to style their top level page after the spec. So your top headers are User/ Admin/ Configuration/ etc | 11:14 |
| asettle | robcresswell: that's pretty good advice | 11:14 |
| robcresswell | It would be fairly easy to add another demo page too, I guess. | 11:14 |
| robcresswell | to manuals, or something | 11:14 |
| sambetts | there's just several ways to interpret that, at one point our index page was just going to be a single toctree, with no other info, because the headers are pulled in from the sub-pages | 11:14 |
| sambetts | but that looks damn awful | 11:15 |
| *** warlord77 has quit IRC | 11:15 | |
| robcresswell | IMO copy Horizon, those guys are great. | 11:15 |
| sambetts | ;) | 11:15 |
| AJaeger | asettle, sambetts : Theme and common entry points -> so, if you have admin docs, iet should be doc/source/admin etc. | 11:15 |
| AJaeger | robcresswell: they are indeed ;) | 11:16 |
| asettle | robcresswell: 'guy' there's only one of you man | 11:16 |
| sambetts | and obviously we don't want to duplicate info between a doc/source/index.rst Contributor section and say doc/source/contributor/index.rst, so should index.rst just have a striaght link to contributor/index.rst and nothing else, etc etc, these are all questions that have come up on our doc migration patches | 11:17 |
| robcresswell | AJaeger: I think Sam is asking more about the page structure rather than code structure. So, if you look at http://docs-draft.openstack.org/51/480251/5/check/gate-ironic-inspector-docs-ubuntu-xenial/f87ae8e//doc/build/html/ | 11:18 |
| robcresswell | You can see that it just has a top level Index, which is a little meaningless etc | 11:18 |
| *** w77 has joined #openstack-doc | 11:19 | |
| sambetts | +1 code structure is concrete in the spec, but page design is much fluffyer | 11:19 |
| sambetts | literally just a one liner at the top of the doc-migration etherpad that says a good example of what the index page should look like <link to horizon's doc index> or something like that would be nice | 11:19 |
| AJaeger | robcresswell: yes, I understood he asked page structure - and we haven't done that yet. | 11:20 |
| robcresswell | Time for project ego fight | 11:20 |
| robcresswell | Ah, sorry, just wanted to be sure | 11:20 |
| AJaeger | sambetts: You will have an external link to your contributor docs -> to contributor/index.html . So, if there's extra infromation on another page, it will break the user experience | 11:21 |
| sambetts | the problem is that no wants to land the doc migration patches because the docs look terrible | 11:21 |
| AJaeger | sambetts: one step at a time, ask them to merge and iterate! | 11:21 |
| sambetts | we're just constantly commenting "we'll deal with the look later merge this" | 11:22 |
| amotoki | I see several patterns of top level structure: https://docs.openstack.org/glance/latest/ (no section title at the top page), https://docs.openstack.org/horizon/latest/ (rough sections), https://docs.openstack.org/neutron/latest/ (section per doc type) | 11:23 |
| AJaeger | argh ;( | 11:23 |
| sambetts | yeah... and this is the wall we're hitting trying to land these patches, everyone loves a bike shed | 11:25 |
| amotoki | Looking at Ironic draft page, the section titles "Index" and "Indices and tables" might be unnecessary. | 11:26 |
| sambetts | yeah, I'm looking at redoing it to try to make it constent among all the ironic projects | 11:28 |
| asettle | actually, sambetts while you're here - ironic using the python openstack client, yes? :) | 11:36 |
| asettle | For newton + | 11:38 |
| sambetts | we have support for both in python-ironicclient, they should have feature parity now | 11:49 |
| *** thorst has joined #openstack-doc | 11:54 | |
| *** thorst_ has joined #openstack-doc | 11:56 | |
| *** thorst_ has quit IRC | 11:56 | |
| asettle | Sweet, thanks sambetts | 11:56 |
| openstackgerrit | Merged openstack/openstack-manuals master: [www] Regenerate sitemap.xml https://review.openstack.org/486350 | 11:56 |
| *** thorst_ has joined #openstack-doc | 11:57 | |
| *** belmoreira has quit IRC | 11:58 | |
| *** thorst has quit IRC | 11:58 | |
| *** w77 has quit IRC | 12:11 | |
| *** yamamoto has quit IRC | 12:19 | |
| *** rbowen has joined #openstack-doc | 12:34 | |
| *** masaki has quit IRC | 12:35 | |
| *** yamamoto has joined #openstack-doc | 12:36 | |
| *** yamamoto has quit IRC | 12:36 | |
| *** catintheroof has joined #openstack-doc | 12:42 | |
| *** chlong has joined #openstack-doc | 12:53 | |
| openstackgerrit | Andreas Jaeger proposed openstack/openstack-manuals master: Explain new project specific doc layout https://review.openstack.org/486368 | 12:53 |
| *** mriedem has joined #openstack-doc | 12:59 | |
| *** edmondsw has joined #openstack-doc | 12:59 | |
| *** dustins has joined #openstack-doc | 13:04 | |
| *** lucasxu has joined #openstack-doc | 13:11 | |
| openstackgerrit | Merged openstack/openstackdocstheme master: Move from 3rd party fonts to native font stack https://review.openstack.org/486087 | 13:27 |
| openstackgerrit | Andreas Jaeger proposed openstack/openstack-manuals master: Move from 3rd party fonts to native font stack https://review.openstack.org/486609 | 13:28 |
| AJaeger | robcresswell, asettle, followup for www index pages since we merged the openstackdocstheme one by robcresswell ^ | 13:28 |
| asettle | Thanks AJaeger :) | 13:29 |
| *** yamamoto has joined #openstack-doc | 13:36 | |
| *** Dinesh_Bhor has joined #openstack-doc | 13:40 | |
| *** gouthamr has joined #openstack-doc | 13:40 | |
| openstackgerrit | Andreas Jaeger proposed openstack/openstack-manuals master: Move from 3rd party fonts to native font stack https://review.openstack.org/486609 | 13:43 |
| *** yamamoto has quit IRC | 13:44 | |
| *** tylerderosagrund has joined #openstack-doc | 13:58 | |
| *** vijaykc4 has joined #openstack-doc | 14:04 | |
| *** efoley has joined #openstack-doc | 14:04 | |
| *** alexchadin has quit IRC | 14:06 | |
| dhellmann | asettle, AJaeger : o/ | 14:08 |
| *** ifat_afek has joined #openstack-doc | 14:09 | |
| *** tylerderosagrund has quit IRC | 14:10 | |
| ifat_afek | dhellmann: Hi, I have a question regarding the doc migration | 14:11 |
| asettle | o/dh :) | 14:13 |
| asettle | dhellmann: | 14:13 |
| asettle | Can't tab complete this morning | 14:13 |
| asettle | ifat_afek: what's your question? :) | 14:13 |
| ifat_afek | asettle: Hi | 14:13 |
| asettle | o/ | 14:14 |
| ifat_afek | According to the doc migration burndown that dhellmann sent, there are missing urls for Vitrage admin and config guides. We don’t have such guides… What should we do? | 14:14 |
| dhellmann | ideally, you will eventually write them. for now, I will mark those as not expected in the burndown generator | 14:15 |
| *** vijaykc4 has quit IRC | 14:15 | |
| ifat_afek | dhellmann: Ok, thanks. And indeed we hope to write them someday… | 14:15 |
| openstackgerrit | Merged openstack/openstack-manuals master: Explain new project specific doc layout https://review.openstack.org/486368 | 14:16 |
| dhellmann | ifat_afek : if you're using oslo.config, the config guide is pretty easy using the sphinx extension | 14:16 |
| dhellmann | ifat_afek : https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html | 14:17 |
| ifat_afek | dhellmann: Thanks! I’ll have a look | 14:17 |
| dhellmann | robcresswell : are you happy with https://review.openstack.org/#/c/486609/2 ? If so, I will +a it | 14:18 |
| robcresswell | dhellmann: Yessir. +1 | 14:18 |
| dhellmann | fire in the hole | 14:18 |
| robcresswell | :o | 14:18 |
| robcresswell | Once I've got this cycle done, I'll have a bit more time to help out with cleaning up some of the docs themes and helping unify some of the other projects if you still need a hand. | 14:19 |
| *** annegentle has joined #openstack-doc | 14:20 | |
| dhellmann | robcresswell : ++ yes, please! | 14:23 |
| openstackgerrit | Merged openstack/openstack-manuals master: Move from 3rd party fonts to native font stack https://review.openstack.org/486609 | 14:24 |
| AJaeger | morning, dhellmann | 14:39 |
| dhellmann | o/ | 14:39 |
| dhellmann | AJaeger : this weekend we talked about me taking over https://review.openstack.org/#/c/486209/ I think -- do you still want me to do that? | 14:40 |
| AJaeger | dhellmann: yes, please! | 14:40 |
| dhellmann | ok, I'll do that today | 14:41 |
| AJaeger | thanks | 14:45 |
| AJaeger | dhellmann: but please look first at the 404s from docs.openstack.org/ocata/index.html | 14:45 |
| dhellmann | AJaeger : ok. do we have a list of those? | 14:46 |
| dhellmann | I made notes of a few | 14:46 |
| dhellmann | but those were all newton | 14:46 |
| AJaeger | dhellmann: just check all top-level links on that page, I have: https://docs.openstack.org/user-guide/ https://docs.openstack.org/user-guide/UserGuide.pdf https://docs.openstack.org/admin-guide/ https://docs.openstack.org/ops-guide/ https://docs.openstack.org/api/ | 14:48 |
| AJaeger | all give 404 | 14:48 |
| dhellmann | ok | 14:48 |
| AJaeger | So, I'm mainly concerned about old/current docs deliverables. | 14:48 |
| AJaeger | Let's check the pike page as well, it might get additional 404s... | 14:49 |
| AJaeger | Sorry, can't help much today | 14:49 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: [www] Draft -> Pike https://review.openstack.org/486209 | 14:52 |
| dhellmann | AJaeger : ok, I'll review those | 14:52 |
| dhellmann | well that's fun | 14:56 |
| *** shaunm has quit IRC | 14:56 | |
| dhellmann | AJaeger, asettle: we removed the ocata admin guide, and the projects don't have admin info in tree for ocata, so where should we point to for that? | 14:56 |
| AJaeger | dhellmann: I think we somehow broke some of the redirects | 14:56 |
| dhellmann | AJaeger : that redirect works, it just points to a page that doesn't exist | 14:57 |
| asettle | Ah, well, that explains that | 14:57 |
| AJaeger | dhellmann: I thought we had a working redirect on Thursday | 14:57 |
| dhellmann | there's no www/ocata/admin/index.html template, so we can make one, but what would it contain? | 14:57 |
| AJaeger | dhellmann: yes, the unversioned guides - like admin guide - were removed automatically when we removed them from openstack-manuals | 14:58 |
| dhellmann | AJaeger : /ocata/index.html links to /admin-guide/ which redirects to /ocata/admin/index.html which doesn't exist. So the redirect isn't the problem, it's the missing page | 14:58 |
| dhellmann | at least for that case | 14:58 |
| dhellmann | should I make ocata link to latest? | 14:59 |
| AJaeger | ah, we had /admin/index.html which is now /pike/admin/index.html | 14:59 |
| dhellmann | right | 14:59 |
| AJaeger | dhellmann: yes, that would work | 14:59 |
| dhellmann | ok, I'll stick in the landing page with a message about why there are no guides and then a link over to /latest/admin/ | 15:00 |
| *** annegentle has quit IRC | 15:00 | |
| AJaeger | dhellmann: http://docs-draft.openstack.org/09/486209/4/check/gate-openstack-manuals-tox-doc-publish-checkbuild/6846250//publish-docs/www/pike/install/index.html does not show Pike ;( | 15:02 |
| dhellmann | AJaeger : yeah, I'm not done with that, I just wanted to see if it was working any better with the s/series/SERIES/g change | 15:03 |
| AJaeger | ah... | 15:03 |
| *** lucasxu has quit IRC | 15:03 | |
| dhellmann | I WIPed it | 15:03 |
| *** donghao has joined #openstack-doc | 15:09 | |
| *** ifat_afek has quit IRC | 15:12 | |
| mriedem | the docs theme seems jacked up here a bit https://docs.openstack.org/nova/latest/cells.html | 15:16 |
| mriedem | https://docs.openstack.org/nova/latest/cells.html#cells-v1 | 15:16 |
| *** annegentle has joined #openstack-doc | 15:20 | |
| *** chlong_ has joined #openstack-doc | 15:21 | |
| AJaeger | mriedem: wow ;( | 15:23 |
| *** chlong has quit IRC | 15:24 | |
| AJaeger | robcresswell, dhellmann, any idea what's broken with the doc them on mriedem 's link? Should mriedem file a bug? | 15:27 |
| robcresswell | woah | 15:28 |
| dhellmann | are there 2 top level headings with the same rst style on that page? | 15:28 |
| robcresswell | AJaeger: did you do a new docstheme release? | 15:28 |
| AJaeger | robcresswell: last week we did one | 15:28 |
| AJaeger | dhellmann: No, doesn't look like it | 15:28 |
| AJaeger | http://git.openstack.org/cgit/openstack/nova/tree/doc/source/cells.rst is the file | 15:29 |
| robcresswell | I was just about to ask :p | 15:29 |
| AJaeger | Is Status the problem? | 15:30 |
| robcresswell | AJaeger: Yeah, I've got it | 15:30 |
| robcresswell | AJaeger: If you open the debugger and turn off the #status rules, its fine. For some reason, someone's given an id called status a bunch of rules | 15:31 |
| robcresswell | And so when you have a header called status, which has automatically defined id of status, it breaks | 15:31 |
| AJaeger | Check http://git.openstack.org/cgit/openstack/openstackdocstheme/tree/openstackdocstheme/theme/openstackdocs/static/css/combined.css#n409 | 15:31 |
| robcresswell | Any idea where that is used | 15:31 |
| robcresswell | ? | 15:31 |
| AJaeger | robcresswell: argh ;( | 15:31 |
| robcresswell | Need to find the original usage of #status | 15:32 |
| robcresswell | so, grep for id="status" I guess. | 15:32 |
| AJaeger | that comes from the initial import ;( | 15:33 |
| AJaeger | I don't see it used | 15:33 |
| robcresswell | Whats @group compute mean? | 15:33 |
| AJaeger | annegentle: any ideas? ^ | 15:34 |
| * AJaeger needs to leave now, will try to be back online later | 15:34 | |
| *** rcernin has quit IRC | 15:34 | |
| dhellmann | why is the theme assuming an entry id values at all? | 15:34 |
| dhellmann | s/an/any | 15:34 |
| annegentle | dhellmann yeah that's my first question also... thinking... | 15:35 |
| annegentle | dhellmann status isn't meaningful for API docs is it? | 15:35 |
| dhellmann | I don't know what goes into the API docs, so I'm not sure | 15:35 |
| annegentle | robcresswell is there a "status" table? | 15:35 |
| annegentle | hm | 15:35 |
| AJaeger | annegentle: it was part of *initial* import of the theme - commit 5150996122448088eab187603fc616393c6ba9f8 | 15:35 |
| AJaeger | so, that is older than API docs | 15:36 |
| AJaeger | bbl | 15:36 |
| robcresswell | Axe it, see what happens :) | 15:36 |
| robcresswell | OpenStack 101 | 15:36 |
| * annegentle looks | 15:37 | |
| robcresswell | IDs should be single use; I doubt the docs theme (because its supposed to be so generic) should ever use them anyway. | 15:38 |
| robcresswell | So really we just need to see what is using it, and alter it, and remove that rule. | 15:38 |
| annegentle | I don't see "status" when I search in https://github.com/openstack/openstackdocstheme/commit/5150996122448088eab187603fc616393c6ba9f8 -- what am I looking for, #status in the CSS? | 15:40 |
| annegentle | robcresswell ^^ you may know | 15:40 |
| robcresswell | annegentle: yeah, its in combined.css, which isn't loaded in that view because the diff is too large | 15:41 |
| robcresswell | annegentle: https://github.com/openstack/openstackdocstheme/blame/master/openstackdocstheme/theme/openstackdocs/static/css/combined.css#L409 | 15:43 |
| robcresswell | annegentle: If you scroll up a bit (to L366) you'll see what it mentions the 3 year old commit that added that in :) | 15:43 |
| annegentle | robcresswell ohhh okay. So why does status conflict with sphinx? | 15:43 |
| robcresswell | annegentle: Sphinx automatically adds an ID to headers so that you can link to a specific header | 15:44 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add ocata/admin landing page https://review.openstack.org/486667 | 15:45 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove link to ops-guide from ocata landing page https://review.openstack.org/486668 | 15:45 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add ocata/api landing page https://review.openstack.org/486669 | 15:45 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add ocata/user landing page https://review.openstack.org/486670 | 15:45 |
| dhellmann | AJaeger, asettle : I think these fix the 404s for ocata ^^ | 15:45 |
| dhellmann | annegentle : ^^ | 15:45 |
| annegentle | but css wants to do something with that ID? Because it has #status in the CSS? | 15:45 |
| annegentle | robcresswell ^ erp | 15:45 |
| robcresswell | annegentle: So, in websites in general, you can link to a specific ID in a page's HTML by added #<id>. Sphinx adds that ID to the headers to make it easy to link to specific entries in a big doc. Unfortunately, at some point, someone has decided to add their own piece of HTML with an id of "status" (probably a big green message, from the looks of things), so when Nova added a Status header, the automatic | 15:46 |
| robcresswell | id gained the styling for that rule. | 15:46 |
| *** imacdonn has quit IRC | 15:46 | |
| annegentle | robcresswell ahhh. | 15:47 |
| robcresswell | Basically its naive usage of IDs. They should be unique. | 15:47 |
| annegentle | robcresswell right | 15:47 |
| robcresswell | but #status is wayyyy too generic :p | 15:47 |
| robcresswell | So if there's anywhere that uses the theme that has a big green message, thats where its being used. I'm not too familiar with much content outside Horizon though | 15:48 |
| annegentle | robcresswell so what's the fix? in the CSS or in the content? | 15:48 |
| dhellmann | short term we could have the nova team change the heading there, but long term we need to make any ids used in the theme unique | 15:49 |
| dhellmann | like prefix all id names with openstackdocstheme- or something | 15:49 |
| dhellmann | when we do that, we'll break wherever this style is being used | 15:49 |
| robcresswell | A better solution would be to stop using IDs as CSS selectors | 15:49 |
| annegentle | dhellmann oh like os-status | 15:49 |
| robcresswell | Its rarely useful | 15:49 |
| annegentle | robcresswell is that the best practice today? | 15:49 |
| dhellmann | http://codesearch.openstack.org/?q=id%3D%22status%22&i=nope&files=&repos= | 15:50 |
| annegentle | I mean three years is a LONNNG time | 15:50 |
| robcresswell | dhellmann: Cheers for that, I was just trying to figure out the best way to do a code search that wide. | 15:51 |
| dhellmann | it looks like "status" is a field used in the api-ref generator? | 15:51 |
| dhellmann | oh, no, it's a field to some of the nova calls, nevermind | 15:53 |
| robcresswell | Using the ID itself is not problematic; globally applying CSS to it, is. | 15:53 |
| dhellmann | the theme has a style for linking to a CitrixVideo? | 15:54 |
| robcresswell | IDs as a semantic element need to be unique per document, so you can link to a specific place in the doc. Accessibility tools also use IDs. | 15:54 |
| dhellmann | looks like this could use some cleansing | 15:54 |
| robcresswell | haa | 15:54 |
| robcresswell | Yeah, cleaning up that CSS is on my list for post-Pike. Was chatting with asettle about it. Already went through the headers and dropped 60 lines or so. | 15:54 |
| robcresswell | Just needs to be carefully/gradually done. | 15:55 |
| * asettle scoops back in again | 15:55 | |
| asettle | You rang? | 15:55 |
| robcresswell | dhellmann: Where in the api-ref generator is it being used? I'm not familiar with it | 15:55 |
| dhellmann | robcresswell : I'm still digging around looking for that | 15:55 |
| dhellmann | I thought I found it, but that was a reference to a parameter to a nova call | 15:56 |
| dhellmann | I'm building nova's api-ref now to see if I can find a #status in that | 15:56 |
| *** rbowen has quit IRC | 15:57 | |
| *** nicolasbock has quit IRC | 15:57 | |
| annegentle | robcresswell dhellmann hm, only generator I know of was one that mugsie wrote as a Sphinx extension | 15:57 |
| *** rbowen has joined #openstack-doc | 15:57 | |
| *** rcernin has joined #openstack-doc | 15:58 | |
| *** imacdonn has joined #openstack-doc | 15:58 | |
| robcresswell | It may well be that its legacy code from way-back-when | 15:58 |
| dhellmann | I think it probably is | 15:58 |
| dhellmann | if it was used in the api-ref, I can't imagine how that would work out -- only one status per page? | 15:59 |
| dhellmann | and I'm not finding any elements with that id anywhere in nova's api-ref build | 15:59 |
| robcresswell | Also worth noting that removing that won't *break* anything, it'll just result in an unstyled status paragraph. | 15:59 |
| dhellmann | I say we remove it from the theme and cut a release | 15:59 |
| dhellmann | true | 15:59 |
| annegentle | robcresswell seems like a fine idea | 15:59 |
| robcresswell | dhellmann: So, the web being the web, ID uniqueness is not enforced. You can reuse them, and CSS will apply to all of them. | 15:59 |
| dhellmann | oh, fun | 16:00 |
| robcresswell | But JS for example, if you search by ID, will return the first element, because uniqueness is assumed. | 16:00 |
| robcresswell | Yup. | 16:00 |
| dhellmann | I am also not finding id="status" in any form in the api-guide | 16:02 |
| dhellmann | so I think it's safe to remove it | 16:02 |
| robcresswell | As a general rule, for something as wide cast and generalised as a docs theme, we should really try and avoid IDs OR make them extremely specific in application, like #nova-index-page-opening-paragraph, or by nesting them several times like .some-class > .another-class > #id | 16:02 |
| robcresswell | dhellmann: +1. As I said earlier, its low risk too. | 16:02 |
| dhellmann | ++ | 16:02 |
| robcresswell | I'll put up a patch | 16:02 |
| dhellmann | cool, then annegentle and I can approve | 16:02 |
| annegentle | robcresswell thanks, feels low risk to me too | 16:03 |
| robcresswell | my thinking exactly :) | 16:03 |
| dhellmann | annegentle, robcresswell : I also added a note to the theme section of https://etherpad.openstack.org/p/doc-future-problems so we track this as something we need to work on | 16:06 |
| openstackgerrit | Rob Cresswell proposed openstack/openstackdocstheme master: Remove rules linked to a "Status" ID https://review.openstack.org/486680 | 16:06 |
| dhellmann | looking at the context, I wonder if these rules came from the project-navigator site | 16:07 |
| robcresswell | dhellmann: ++, I added a link to the patch after your comment. | 16:07 |
| dhellmann | "availability" | 16:07 |
| dhellmann | "projectVitals" | 16:08 |
| *** andreas_s has quit IRC | 16:08 | |
| dhellmann | though I don't know what they mean by parallax there | 16:08 |
| dhellmann | robcresswell : thanks | 16:08 |
| *** chlong__ has joined #openstack-doc | 16:13 | |
| *** chlong_ has quit IRC | 16:13 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add SERIES_TITLE template variable https://review.openstack.org/486209 | 16:22 |
| dhellmann | AJaeger: ^^ fixes the "draft" title situation correctly | 16:22 |
| *** chlong_ has joined #openstack-doc | 16:40 | |
| *** chlong__ has quit IRC | 16:41 | |
| AJaeger | dhellmann: thanks, will review later | 16:46 |
| AJaeger | robcresswell, annegentle, dhellmann should we remove also #parallax and #availability ? | 16:46 |
| robcresswell | AJaeger: In time, but #status we've actually researched, but the others we havent | 16:46 |
| AJaeger | robcresswell: ok ;) | 16:48 |
| openstackgerrit | Merged openstack/openstackdocstheme master: Remove rules linked to a "Status" ID https://review.openstack.org/486680 | 16:53 |
| openstackgerrit | Merged openstack/openstackdocstheme master: Update 2 documentation URLs according to doc migration https://review.openstack.org/486533 | 16:53 |
| openstackgerrit | Merged openstack/openstackdocstheme master: Fix Added / Changed / Deprecated notices https://review.openstack.org/485290 | 16:53 |
| *** pkovar has quit IRC | 17:02 | |
| *** fragatina has quit IRC | 17:06 | |
| *** chlong_ has quit IRC | 17:08 | |
| *** chlong_ has joined #openstack-doc | 17:10 | |
| *** efoley has quit IRC | 17:15 | |
| *** donghao has quit IRC | 17:21 | |
| sambetts | asettle: Any idea when phase2 of doc migration is happening? e.g. the http API refs etc?? | 17:23 |
| sambetts | AJaeger: ^ | 17:25 |
| *** sambetts is now known as sambetts|afk | 17:33 | |
| *** fragatin_ has joined #openstack-doc | 17:34 | |
| *** fragatin_ has quit IRC | 17:34 | |
| *** fragatin_ has joined #openstack-doc | 17:34 | |
| *** fragatina has joined #openstack-doc | 17:37 | |
| dhellmann | sambetts|afk : I think we're postponing any other major changes until queens. We need to regroup and make sure we have phase 2 planned out. | 17:37 |
| *** fragatina has quit IRC | 17:37 | |
| *** fragatin_ has quit IRC | 17:37 | |
| *** fragatina has joined #openstack-doc | 17:38 | |
| AJaeger | dhellmann: let me cut an openstackdocstheme release now... | 17:38 |
| *** thorst_ has quit IRC | 17:38 | |
| dhellmann | AJaeger : ++ | 17:38 |
| AJaeger | asettle dhellmann, annegentle, robcresswell, mriedem https://review.openstack.org/486705 is the new release of openstackdocstheme | 17:41 |
| dhellmann | I'll watch for the jobs to finish on that patch and then approve it if it looks ok | 17:41 |
| AJaeger | thanks | 17:44 |
| *** thorst has joined #openstack-doc | 17:44 | |
| *** thorst has quit IRC | 17:49 | |
| AJaeger | dhellmann: we have the www/template directory that references the guide you fixed for ocata - I fear those need updating as well... | 17:54 |
| * AJaeger just double checked the newton page and gets similar 404s | 17:54 | |
| dhellmann | AJaeger : looking | 17:56 |
| AJaeger | mriedem: next nova publish should look nice again - openstackdocstheme is released | 18:11 |
| * AJaeger waves good bye | 18:11 | |
| *** thorst has joined #openstack-doc | 18:12 | |
| mriedem | AJaeger: great thanks | 18:12 |
| *** rcernin has quit IRC | 18:16 | |
| *** pkovar has joined #openstack-doc | 18:20 | |
| mriedem | i'm trying to find where this lives now https://docs.openstack.org/ocata/config-reference/compute/cells.html | 18:50 |
| mriedem | i don't see it in openstack-manuals | 18:50 |
| mriedem | or nova | 18:50 |
| mriedem | oh i found it https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/config-reference/source/compute/cells.rst | 18:51 |
| mriedem | it's on the stable/ocata branch | 18:51 |
| mriedem | stephenfin: are you moving the stuff from ^ into nova too? | 18:51 |
| openstackgerrit | Matt Riedemann proposed openstack/openstack-manuals stable/ocata: Update and expand cells config doc warning https://review.openstack.org/486724 | 18:53 |
| mriedem | aha | 18:53 |
| *** annegentle has quit IRC | 19:00 | |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add admin landing pages for older series https://review.openstack.org/486667 | 19:05 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add SERIES_TITLE template variable https://review.openstack.org/486209 | 19:05 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add user landing pages for older releases https://review.openstack.org/486670 | 19:05 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add api landing pages for older releases https://review.openstack.org/486669 | 19:05 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove link to ops-guide from series landing pages https://review.openstack.org/486668 | 19:05 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: run the link checks in parallel https://review.openstack.org/486728 | 19:05 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add options to template generator to make it easier to only test links https://review.openstack.org/486729 | 19:05 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove series pages for EOL series https://review.openstack.org/486730 | 19:05 |
| *** thorst is now known as thorst_afk | 19:15 | |
| dhellmann | jungleboyj : do you have a bug you're working from for the cinder doc migration? | 19:16 |
| jungleboyj | No, I just have all the changes I am doing under a doc-bld-fix topic | 19:29 |
| *** reed has quit IRC | 19:31 | |
| *** reed has joined #openstack-doc | 19:32 | |
| dhellmann | jungleboyj : ok, thanks | 19:32 |
| dhellmann | jungleboyj : oh, not doc-migration like the spec says? | 19:33 |
| jungleboyj | So, those are all the pieces for fixing the Sphinx 'WARNINGs' that came over from openstack-manuals. | 19:39 |
| jungleboyj | As far as the migration goes I have what I have done documented in an etherpad. Let me get that. | 19:39 |
| jungleboyj | https://etherpad.openstack.org/p/cinder-docs-migration | 19:40 |
| jungleboyj | dhellmann: ^^ | 19:40 |
| jungleboyj | I haven't crossed out what has merged. I need to do that and push the info back to the master etherpad. | 19:40 |
| dhellmann | jungleboyj : ok, cool, I just wanted to make sure I wasn't missing the opportunity to count those commits | 19:40 |
| dhellmann | jungleboyj : I'm opening bugs for other projects that appear not to have started their migration or that have work left. I know you're working on cinder, so I don't do that for cinder | 19:41 |
| dhellmann | s/don't/won't | 19:41 |
| jungleboyj | dhellmann: Gotcha. Thanks for checking up on us. I think we are making good process. | 19:42 |
| jungleboyj | *progress | 19:42 |
| jungleboyj | dhellmann: I was going to check with you last week. Is this process tied to any release? I know we want to have it done in Pike but is there a date where we have to be totally done? | 19:43 |
| dhellmann | jungleboyj : you want it done before you branch, otherwise you'll have to backport the docs to publish them for pike | 19:43 |
| jungleboyj | Ok. Sounds good. So before we cut Pike and move to Queens. | 19:46 |
| dhellmann | right | 20:05 |
| jungleboyj | dhellmann: Cool. Thanks! | 20:11 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add admin landing pages for older series https://review.openstack.org/486667 | 20:26 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add SERIES_TITLE template variable https://review.openstack.org/486209 | 20:26 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add user landing pages for older releases https://review.openstack.org/486670 | 20:26 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove series pages for EOL series https://review.openstack.org/486730 | 20:26 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add api landing pages for older releases https://review.openstack.org/486669 | 20:26 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add options to template generator to make it easier to only test links https://review.openstack.org/486729 | 20:26 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: remove link to ops-guide from series landing pages https://review.openstack.org/486668 | 20:26 |
| openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: run the link checks in parallel https://review.openstack.org/486728 | 20:26 |
| * dhellmann glares at flake8 | 20:26 | |
| dhellmann | asettle : I opened bugs for all of the projects that haven't completed the migration work and added links to the bugs to https://etherpad.openstack.org/p/doc-migration-tracking | 20:32 |
| dhellmann | next step is to contact the PTLs | 20:32 |
| * asettle is technically not here | 20:32 | |
| asettle | But hooray! | 20:32 |
| asettle | Thanks :D | 20:32 |
| * dhellmann looks at the clock | 20:33 | |
| * asettle mumbles something about online shopping | 20:33 | |
| * dhellmann needs some new socks | 20:33 | |
| asettle | I love sock shopping! | 20:33 |
| asettle | There is no irony there | 20:33 |
| asettle | I really just like sock shopping | 20:33 |
| asettle | Would you chose: http://www.asos.com/prd/7904229 or http://www.asos.com/prd/8112189 for a fancy event? | 20:34 |
| dhellmann | I'm hesitating to ask for suggestions for sites | 20:34 |
| dhellmann | probably not, I don't usually like to show my knees | 20:34 |
| asettle | Okay well, in a world where you weren't worried about your knees... | 20:35 |
| asettle | dhellmann: say no more - https://www.happysocks.com | 20:35 |
| dhellmann | of course | 20:35 |
| dhellmann | how fancy is this event? | 20:37 |
| asettle | It's a friends uni ball... | 20:37 |
| dhellmann | I'm probably the last person to be asking for advice on dresses. What's more in fashion now, sleeves or sleeveless? | 20:39 |
| asettle | You know, I actually don't know either :p | 20:39 |
| asettle | Andy is complimenting you on your diplomacy, btw :p | 20:40 |
| dhellmann | I've had some practice. | 20:40 |
| asettle | Props. You did good! | 20:43 |
| dhellmann | heh | 20:43 |
| dhellmann | right, I'm done for the day | 20:44 |
| dhellmann | asettle : ttyl | 20:44 |
| asettle | o/ night! | 20:44 |
| *** annegentle has joined #openstack-doc | 20:54 | |
| *** MeganR has joined #openstack-doc | 20:55 | |
| *** edmondsw has quit IRC | 21:04 | |
| *** edmondsw has joined #openstack-doc | 21:04 | |
| *** edmondsw_ has joined #openstack-doc | 21:05 | |
| *** edmondsw has quit IRC | 21:09 | |
| *** yamamoto_ has joined #openstack-doc | 21:09 | |
| *** edmondsw_ has quit IRC | 21:10 | |
| *** yamamoto_ has quit IRC | 21:20 | |
| *** dustins has quit IRC | 21:27 | |
| *** MeganR has quit IRC | 21:35 | |
| *** edmondsw has joined #openstack-doc | 21:39 | |
| *** edmondsw has quit IRC | 21:44 | |
| *** yamamoto has joined #openstack-doc | 22:01 | |
| *** fragatin_ has joined #openstack-doc | 22:14 | |
| *** fragatina has quit IRC | 22:18 | |
| *** gouthamr has quit IRC | 22:27 | |
| *** suyog has joined #openstack-doc | 22:38 | |
| *** gouthamr has joined #openstack-doc | 22:41 | |
| *** fragatin_ has quit IRC | 22:42 | |
| *** fragatina has joined #openstack-doc | 22:43 | |
| openstackgerrit | Matt Riedemann proposed openstack/openstack-manuals stable/ocata: Update and expand cells config doc warning https://review.openstack.org/486724 | 22:50 |
| *** pkovar has quit IRC | 22:53 | |
| *** catintheroof has quit IRC | 23:21 | |
| *** chlong__ has joined #openstack-doc | 23:36 | |
| *** chlong_ has quit IRC | 23:37 | |
Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!