| *** jamesmcarthur has joined #openstack-doc | 00:00 | |
| *** jamesmcarthur has quit IRC | 00:16 | |
| *** jamesmcarthur has joined #openstack-doc | 00:17 | |
| *** jamesmcarthur_ has joined #openstack-doc | 00:26 | |
| *** jamesmcarthur has quit IRC | 00:26 | |
| *** jamesmcarthur_ has quit IRC | 00:29 | |
| *** jamesmcarthur has joined #openstack-doc | 00:30 | |
| *** jamesmcarthur has quit IRC | 00:30 | |
| *** jamesmcarthur has joined #openstack-doc | 00:32 | |
| *** jamesmcarthur has quit IRC | 00:40 | |
| *** jamesmcarthur has joined #openstack-doc | 00:40 | |
| openstackgerrit | Merged openstack/openstack-manuals master: [www] Fix project-deploy-guide redirects https://review.opendev.org/690667 | 01:56 |
|---|---|---|
| *** tinwood has quit IRC | 02:18 | |
| *** tinwood has joined #openstack-doc | 02:20 | |
| *** jamesmcarthur has quit IRC | 02:25 | |
| *** jamesmcarthur has joined #openstack-doc | 02:30 | |
| *** jamesmcarthur has quit IRC | 03:10 | |
| *** jamesmcarthur has joined #openstack-doc | 03:11 | |
| *** jamesmcarthur has quit IRC | 03:15 | |
| *** jamesmcarthur has joined #openstack-doc | 03:42 | |
| *** jamesmcarthur has quit IRC | 04:27 | |
| *** jamesmcarthur has joined #openstack-doc | 04:31 | |
| *** jamesmcarthur has quit IRC | 04:39 | |
| *** jamesmcarthur has joined #openstack-doc | 04:52 | |
| *** efried has quit IRC | 05:04 | |
| *** efried has joined #openstack-doc | 05:11 | |
| *** jamesmcarthur has quit IRC | 05:13 | |
| *** jamesmcarthur has joined #openstack-doc | 05:20 | |
| *** andyzon has joined #openstack-doc | 05:25 | |
| *** jamesmcarthur has quit IRC | 05:30 | |
| AJaeger | efried: don't do that - if you move the file or change the anchor, sphinx will not tell you. Use :ref: | 05:56 |
| *** andyzon has quit IRC | 06:12 | |
| *** miloa has joined #openstack-doc | 06:31 | |
| *** andyzon has joined #openstack-doc | 06:37 | |
| *** pcaruana has joined #openstack-doc | 06:41 | |
| *** andyzon is now known as jawad_axd | 06:47 | |
| AJaeger | pmatulis, asettle, https://docs.openstack.org/project-deploy-guide/charm-deployment-guide redirect works now ;) | 07:01 |
| *** tosky has joined #openstack-doc | 07:12 | |
| *** kopecmartin|off is now known as kopecmartin | 07:13 | |
| *** tesseract has joined #openstack-doc | 07:18 | |
| asettle | Thanks AJaeger :) | 08:19 |
| *** jawad_axd has quit IRC | 08:48 | |
| *** jawad_axd has joined #openstack-doc | 08:48 | |
| *** jawad_axd has quit IRC | 08:58 | |
| *** njohnston has joined #openstack-doc | 09:08 | |
| njohnston | Hi! Moving a conversation from #openstack-tc to here | 09:09 |
| njohnston | 7 | 09:09 |
| njohnston | I got a question yesterday about docs, was not sure of the answer. I was chatting with a chap from cinder and he asked me about the header we put on docs that are older, that says "This is maintained, but not the current release. The current supported release is Train." He asked, could we have the link deeplink to the train version of the doc you're looking at instead of | 09:10 |
| njohnston | https://docs.openstack.org/train/ | 09:11 |
| njohnston | asettle: example URL is https://docs.openstack.org/neutron/pike/contributor/policies/ | 09:11 |
| asettle | OH! You mean, the banner each time taking you to the actual page, rather than back to docs.openstack.org/train | 09:12 |
| asettle | I get you nowwwwww | 09:12 |
| njohnston | precisely | 09:12 |
| asettle | I was *very* confused in tc | 09:12 |
| asettle | So, I don't see anything wrong with that idea. I understand evrardjp_ 's concerns about 404s though. Could that not just result in a loop? | 09:13 |
| asettle | I like the idea though. Although, I believe the banner is a part of the theme. I'm sure you could initiate something that changes how it is read... | 09:14 |
| njohnston | How would it loop? https://docs.openstack.org/neutron/pike/contributor/policies/ would redirect to https://docs.openstack.org/neutron/train/contributor/policies/ but the latter would just have the "This is the currently supported version" banner. | 09:14 |
| njohnston | With 404s I don't think it's a bad idea in general to ask project teams to leave forwarding pages to say "Update your bookmarks, this info is now at [link]" | 09:15 |
| asettle | I guess I'm concerned that the redirection that is, in theory, created would be a command that says "if this is 404, find the most up-to-date version that works" and it would loop and loop because we've changed the URLs a lot lately | 09:15 |
| njohnston | Oh, I am not suggesting an actual HTTP redirect. Just that the link in the banner links to the deeplink version of the page you are looking at. But you'd still have to click on the link to go there. | 09:18 |
| njohnston | asettle: I don't see the text of the banner anywhere in https://opendev.org/openstack/openstackdocstheme | 09:21 |
| AJaeger | njohnston: you could move files around and then it won't work... | 09:30 |
| AJaeger | njohnston: sure, you can change the link but if you get a 404 every time? | 09:30 |
| AJaeger | njohnston: check https://docs.openstack.org/neutron/ocata/contributor/policies/ | 09:30 |
| AJaeger | so, you get eventual these reorgs in every guide and thus we decided it is not worth it. | 09:31 |
| AJaeger | njohnston: that badge is a global file, see http://codesearch.openstack.org/?q=This%20release%20is%20under%20development.%20The%20current%20supported%20release%20is&i=nope&files=&repos= | 09:34 |
| evrardjp_ | AJaeger: this is why I proposed that, if we bring this feature in, to make sure that we have another link pointing to the top of the build document for a new release, instead of pointing to general documentation page for said new release | 09:35 |
| AJaeger | so, adding a proper link might be quite involved... | 09:35 |
| evrardjp_ | AJaeger: agreed. proper contextual linking would require teams to bring semantic data into their docs page per version. That's a whole lot different | 09:35 |
| AJaeger | or add redirects for each rename... | 09:36 |
| njohnston | or leave a breadcrumb file behind | 09:36 |
| evrardjp_ | njohnston: yeah that's the simplest | 09:37 |
| AJaeger | I'm not sure it's worth the extra effort. I agree it would be nice to have ;) | 09:37 |
| evrardjp_ | AJaeger: welcome to the club I guess? :p | 09:37 |
| njohnston | AJaeger: Do you see page renames/reorgs frequently? In neutron and the other projects I work in I only see new pages getting added - like your earlier link https://docs.openstack.org/neutron/ocata/contributor/policies/ that page was created in pike and has been there ever since. | 09:41 |
| evrardjp_ | njohnston: it might be worth checking if neutron is an exception or not. | 09:52 |
| evrardjp_ | njohnston: OSA for example, redid the documentation quite a few times to improve user friendliness. We were never asked of backwards compatibility. | 09:53 |
| evrardjp_ | njohnston: if you write a tool that finds all the 404 of old branches in branch x, creating the appropriate breadcrumb files in the branch x (with a link to redirecting to the equivalent project top docs), that would be awesome, I guess? :D | 09:55 |
| AJaeger | njohnston: there was a major rework a few releases ago, that will break *older* links | 10:50 |
| AJaeger | meaning, I assume between ocata and stein most links do not work... | 10:51 |
| AJaeger | njohnston: random page: https://docs.openstack.org/neutron/ocata/policies/blueprints.html - does not exist in stein | 10:52 |
| *** alexmcleod has joined #openstack-doc | 10:57 | |
| asettle | AJaeger, that's what I thought too. Mapping those links would be a huge task | 11:46 |
| asettle | Not that I disagree with the idea, i think it's a good one | 11:46 |
| asettle | But yeah, conflicting | 11:46 |
| tosky | but may be possible to parse the information from doc/source/_extra/.htaccess, maybe; but then it would have been useful to have the redirects written down in a more consumable format, which could be used to generate both the htaccess file and those specific redirects, maybe | 11:53 |
| *** jamesmcarthur has joined #openstack-doc | 12:11 | |
| *** jawad_axd has joined #openstack-doc | 12:22 | |
| *** jamesmcarthur has quit IRC | 12:28 | |
| *** jawad_axd has quit IRC | 12:40 | |
| *** jamesmcarthur has joined #openstack-doc | 12:48 | |
| efried | AJaeger: This was an anchor embedded in a support matrix, which is generated, and (afaict) there's no way to inject a ref anchor | 12:49 |
| AJaeger | efried: interesting. Maybe stephenfin has an idea if you share the exact example with us... | 12:50 |
| efried | tosky: fwiw we have that tool in the nova-specs repo | 12:51 |
| efried | (I only read the last few lines, it may not be exactly what you were looking for) | 12:51 |
| efried | AJaeger: it's here: https://review.opendev.org/#/c/690748/1/doc/source/admin/aggregates.rst@374 (I believe stephenfin is on vacation until the summit) | 12:52 |
| AJaeger | efried: why not link to top of page? | 12:54 |
| efried | AJaeger: just because the page is huge and hard to find stuff in. | 12:55 |
| efried | and the anchor *exists* so it's frustrating not to be able to use it. | 12:55 |
| AJaeger | efried: or use a relative :doc: link, so that it works once you branch? | 12:55 |
| efried | You mean :doc: with the anchor? | 12:55 |
| efried | I tried that and it didn't build. | 12:55 |
| AJaeger | ah ;( | 12:56 |
| AJaeger | sorry, then I'm out of ideas | 12:56 |
| efried | AJaeger: Oh, when you say "relative"... | 12:56 |
| efried | you mean :doc:`../user/support-matrix#the_anchor` rather than :doc:`/user/support-matrix#the_anchor` ? | 12:57 |
| efried | I didn't try that | 12:57 |
| *** goldyfruit has joined #openstack-doc | 13:00 | |
| efried | AJaeger: ...nope: WARNING: unknown document: ../user/support-matrix#operation_cache_images | 13:10 |
| efried | Is :doc: an openstackdocstheme thing? I'd like to get a rfe bug/story opened for this. | 13:10 |
| efried | also possible I could make the support matrix generator inject :ref: anchors... | 13:11 |
| AJaeger | :doc: is RST AFAIR | 13:12 |
| *** jamesmcarthur has quit IRC | 13:13 | |
| efried | hmph | 13:19 |
| *** jamesmcarthur has joined #openstack-doc | 13:20 | |
| AJaeger | https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax | 13:21 |
| AJaeger | sphinx docs mention it | 13:22 |
| *** jawad_axd has joined #openstack-doc | 13:39 | |
| *** jawad_axd has quit IRC | 13:44 | |
| *** jawad_axd has joined #openstack-doc | 13:45 | |
| *** jamesmcarthur has quit IRC | 14:06 | |
| *** jamesmcarthur has joined #openstack-doc | 14:17 | |
| *** pcaruana has quit IRC | 14:19 | |
| pmatulis | AJaeger, nicely done | 14:32 |
| pmatulis | AJaeger, could you give me a link to the PR that fixed the redirect? | 14:33 |
| AJaeger | pmatulis: in the backscroll, let me get it... | 14:34 |
| AJaeger | https://review.opendev.org/690667 | 14:34 |
| pmatulis | sweet thx | 14:34 |
| *** kopecmartin is now known as kopecmartin|off | 14:46 | |
| *** evrardjp_ is now known as evrardjp | 14:48 | |
| *** tesseract has quit IRC | 15:49 | |
| *** goldyfruit has quit IRC | 15:54 | |
| *** goldyfruit has joined #openstack-doc | 15:56 | |
| *** ianychoi has joined #openstack-doc | 16:21 | |
| *** jawad_axd has quit IRC | 16:52 | |
| *** tosky has quit IRC | 16:52 | |
| *** alexmcleod has quit IRC | 16:55 | |
| *** jamesmcarthur has quit IRC | 17:29 | |
| *** jamesmcarthur has joined #openstack-doc | 17:31 | |
| *** jamesmcarthur has quit IRC | 17:43 | |
| *** jamesmcarthur has joined #openstack-doc | 17:54 | |
| *** jamesmcarthur has quit IRC | 17:59 | |
| *** tosky has joined #openstack-doc | 18:03 | |
| efried | AJaeger: FYI I submitted an issue and PR to sphinx https://github.com/sphinx-doc/sphinx/issues/6766 | 19:24 |
| *** goldyfruit_ has joined #openstack-doc | 19:57 | |
| *** goldyfruit has quit IRC | 19:59 | |
| *** tosky_ has joined #openstack-doc | 20:00 | |
| *** tosky has quit IRC | 20:03 | |
| *** jamesmcarthur has joined #openstack-doc | 20:14 | |
| *** jamesmcarthur has quit IRC | 20:34 | |
| *** KeithMnemonic has quit IRC | 20:41 | |
| *** KeithMnemonic has joined #openstack-doc | 20:52 | |
| *** gyee has joined #openstack-doc | 21:16 | |
| *** goldyfruit_ has quit IRC | 21:38 | |
| *** miloa has quit IRC | 21:52 | |
| *** rcernin has quit IRC | 22:03 | |
| *** goldyfruit has joined #openstack-doc | 22:03 | |
| *** jawad_axd has joined #openstack-doc | 22:19 | |
| *** jawad_axd has quit IRC | 22:24 | |
| *** tosky_ is now known as tosky | 22:36 | |
| *** tosky has quit IRC | 22:36 | |
| *** jawad_axd has joined #openstack-doc | 22:41 | |
| *** jawad_axd has quit IRC | 22:45 | |
| *** jawad_axd has joined #openstack-doc | 23:01 | |
| *** jawad_axd has quit IRC | 23:06 | |
| *** rcernin has joined #openstack-doc | 23:13 | |
| *** jawad_axd has joined #openstack-doc | 23:22 | |
| *** jawad_axd has quit IRC | 23:26 | |
| *** jawad_axd has joined #openstack-doc | 23:43 | |
| *** jawad_axd has quit IRC | 23:47 | |
Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!