*** masaki has joined #openstack-doc | 00:02 | |
*** masaki has quit IRC | 00:14 | |
*** masaki has joined #openstack-doc | 00:16 | |
*** gmann has quit IRC | 00:16 | |
*** gmann has joined #openstack-doc | 00:16 | |
*** dmacpher has joined #openstack-doc | 00:16 | |
*** phuongnh has joined #openstack-doc | 01:06 | |
*** deep-book-gk has joined #openstack-doc | 01:06 | |
*** deep-book-gk has left #openstack-doc | 01:06 | |
*** sdague has joined #openstack-doc | 01:16 | |
*** edmondsw has joined #openstack-doc | 01:36 | |
*** thorst has joined #openstack-doc | 01:37 | |
*** vijaykc4 has joined #openstack-doc | 01:37 | |
*** edmondsw has quit IRC | 01:40 | |
*** yangyapeng has joined #openstack-doc | 01:41 | |
*** thorst has quit IRC | 01:41 | |
*** yangyape_ has joined #openstack-doc | 01:52 | |
*** yangyapeng has quit IRC | 01:55 | |
*** gouthamr has quit IRC | 02:07 | |
*** vijaykc4 has quit IRC | 02:14 | |
*** thorst has joined #openstack-doc | 02:42 | |
*** thorst has quit IRC | 02:47 | |
*** edmondsw has joined #openstack-doc | 03:24 | |
*** vijaykc4 has joined #openstack-doc | 03:26 | |
*** edmondsw has quit IRC | 03:28 | |
*** yangyape_ has quit IRC | 03:35 | |
*** yangyapeng has joined #openstack-doc | 03:35 | |
*** thorst has joined #openstack-doc | 03:43 | |
*** thorst has quit IRC | 03:48 | |
*** yangyape_ has joined #openstack-doc | 03:51 | |
*** yangyapeng has quit IRC | 03:51 | |
*** yangyape_ has quit IRC | 03:55 | |
*** yangyapeng has joined #openstack-doc | 03:55 | |
*** dmacpher has quit IRC | 03:59 | |
*** junbo has joined #openstack-doc | 04:07 | |
*** dmacpher has joined #openstack-doc | 04:17 | |
*** s-shiono_ has joined #openstack-doc | 04:26 | |
*** rejy has joined #openstack-doc | 04:31 | |
*** rejy has left #openstack-doc | 04:32 | |
*** suyog has quit IRC | 04:35 | |
*** diablo_rojo has joined #openstack-doc | 04:42 | |
*** Dinesh_Bhor has joined #openstack-doc | 04:43 | |
*** khushbu_ has joined #openstack-doc | 04:44 | |
*** vijaykc4 has quit IRC | 04:49 | |
*** suyog has joined #openstack-doc | 04:51 | |
*** dmacpher_ has joined #openstack-doc | 05:02 | |
*** dmacpher has quit IRC | 05:06 | |
*** dhellmann has quit IRC | 05:28 | |
*** dhellmann has joined #openstack-doc | 05:28 | |
*** GK1wmSU has joined #openstack-doc | 05:29 | |
*** GK1wmSU has left #openstack-doc | 05:30 | |
*** vijaykc4 has joined #openstack-doc | 05:32 | |
*** _GK1wmSU has joined #openstack-doc | 05:42 | |
*** thorst has joined #openstack-doc | 05:44 | |
*** _GK1wmSU has left #openstack-doc | 05:45 | |
*** thorst has quit IRC | 05:49 | |
*** rcernin has joined #openstack-doc | 06:11 | |
*** vijaykc4 has quit IRC | 06:16 | |
*** pcaruana has joined #openstack-doc | 06:19 | |
*** amotoki__ is now known as amotoki | 06:33 | |
*** andreas_s has joined #openstack-doc | 06:36 | |
*** suyog has quit IRC | 06:40 | |
*** AJaeger has quit IRC | 06:54 | |
*** edmondsw has joined #openstack-doc | 06:59 | |
*** edmondsw has quit IRC | 07:04 | |
*** AJaeger has joined #openstack-doc | 07:06 | |
*** vijaykc4 has joined #openstack-doc | 07:08 | |
*** vijaykc4 has quit IRC | 07:17 | |
*** dmacpher_ has quit IRC | 07:25 | |
*** charcol has quit IRC | 07:26 | |
*** dhellmann has quit IRC | 07:30 | |
*** dhellmann has joined #openstack-doc | 07:31 | |
*** alexchadin has joined #openstack-doc | 07:31 | |
*** khushbu_ has quit IRC | 07:38 | |
*** phuongnh has quit IRC | 07:38 | |
*** thorst has joined #openstack-doc | 07:45 | |
*** thorst has quit IRC | 07:50 | |
*** khushbu has joined #openstack-doc | 07:53 | |
openstackgerrit | Allen proposed openstack/security-doc master: Add the missing hyperlink markup for the title https://review.openstack.org/489121 | 07:58 |
---|---|---|
*** alexchad_ has joined #openstack-doc | 08:00 | |
*** yamamoto has quit IRC | 08:02 | |
*** alexchadin has quit IRC | 08:02 | |
*** alexchadin has joined #openstack-doc | 08:04 | |
*** alexcha__ has joined #openstack-doc | 08:06 | |
*** alexchad_ has quit IRC | 08:06 | |
*** alexchadin has quit IRC | 08:08 | |
*** alexchadin has joined #openstack-doc | 08:12 | |
*** alexchadin has quit IRC | 08:13 | |
*** alexchadin has joined #openstack-doc | 08:14 | |
*** alexcha__ has quit IRC | 08:15 | |
openstackgerrit | Allen proposed openstack/security-doc master: Add the missing hyperlink markup for the title https://review.openstack.org/489121 | 08:24 |
*** vijaykc4 has joined #openstack-doc | 08:32 | |
*** efoley has joined #openstack-doc | 08:37 | |
*** khushbu has quit IRC | 08:41 | |
*** khushbu has joined #openstack-doc | 08:44 | |
*** edmondsw has joined #openstack-doc | 08:48 | |
openstackgerrit | Allen proposed openstack/security-doc master: Add the missing hyperlink markup for the title https://review.openstack.org/489121 | 08:52 |
*** edmondsw has quit IRC | 08:53 | |
*** masaki has quit IRC | 09:02 | |
*** khushbu has quit IRC | 09:02 | |
*** yamamoto has joined #openstack-doc | 09:02 | |
*** khushbu_ has joined #openstack-doc | 09:03 | |
*** yangyapeng has quit IRC | 09:04 | |
*** yamamoto has quit IRC | 09:08 | |
*** yamamoto has joined #openstack-doc | 09:08 | |
*** khushbu_ has quit IRC | 09:11 | |
*** sambetts|afk is now known as sambetts | 09:11 | |
*** khushbu has joined #openstack-doc | 09:11 | |
*** s-shiono_ has quit IRC | 09:13 | |
*** khushbu has quit IRC | 09:21 | |
*** tosky has joined #openstack-doc | 09:21 | |
*** diablo_rojo has quit IRC | 09:24 | |
*** khushbu has joined #openstack-doc | 09:24 | |
*** yamamoto has quit IRC | 09:25 | |
*** pblaho has joined #openstack-doc | 09:29 | |
*** yamamoto has joined #openstack-doc | 09:34 | |
*** nicolasbock has joined #openstack-doc | 09:35 | |
*** khushbu has quit IRC | 09:38 | |
*** yamamoto has quit IRC | 09:40 | |
*** khushbu_ has joined #openstack-doc | 09:40 | |
*** vijaykc4 has quit IRC | 09:45 | |
*** thorst has joined #openstack-doc | 09:46 | |
openstackgerrit | Allen proposed openstack/security-doc master: Remove the redundant hyperlink https://review.openstack.org/489121 | 09:46 |
*** khushbu_ has quit IRC | 09:53 | |
*** yamamoto has joined #openstack-doc | 09:53 | |
*** khushbu_ has joined #openstack-doc | 09:55 | |
*** khushbu_ has quit IRC | 09:58 | |
*** khushbu has joined #openstack-doc | 09:58 | |
*** thorst has quit IRC | 09:58 | |
*** vijaykc4 has joined #openstack-doc | 10:04 | |
*** khushbu has quit IRC | 10:06 | |
*** khushbu has joined #openstack-doc | 10:08 | |
*** alexchadin has quit IRC | 10:11 | |
*** khushbu has quit IRC | 10:13 | |
*** khushbu_ has joined #openstack-doc | 10:14 | |
*** khushbu_ has quit IRC | 10:17 | |
*** khushbu has joined #openstack-doc | 10:19 | |
*** khushbu has quit IRC | 10:24 | |
*** khushbu has joined #openstack-doc | 10:27 | |
*** vijaykc4 has quit IRC | 10:35 | |
*** edmondsw has joined #openstack-doc | 10:36 | |
*** vijaykc4 has joined #openstack-doc | 10:40 | |
*** edmondsw has quit IRC | 10:41 | |
*** khushbu has quit IRC | 10:43 | |
*** khushbu has joined #openstack-doc | 10:48 | |
*** khushbu has quit IRC | 10:52 | |
*** khushbu has joined #openstack-doc | 11:13 | |
*** alexchadin has joined #openstack-doc | 11:13 | |
*** thorst has joined #openstack-doc | 11:13 | |
*** yamamoto has quit IRC | 11:31 | |
*** thorst has quit IRC | 11:43 | |
*** yamamoto has joined #openstack-doc | 12:01 | |
*** vijaykc4 has quit IRC | 12:02 | |
*** vijaykc4 has joined #openstack-doc | 12:02 | |
*** yamamoto has quit IRC | 12:04 | |
*** edmondsw has joined #openstack-doc | 12:06 | |
dhellmann | asettle : happy monday! | 12:09 |
dhellmann | it looks like we have a few projects who have landed docs but not updated the flags in the manuals repo: http://paste.openstack.org/show/616995/ | 12:10 |
dhellmann | maybe it would be a good idea to send an email encouraging them to do so? | 12:10 |
asettle | dhellmann: is it though! | 12:10 |
asettle | dhellmann: would indeed be :) I'm in meetings for the next forty thousand hours | 12:10 |
* dhellmann doesn't do philosophy before breakfast | 12:10 | |
asettle | I can do it after work otnight | 12:10 |
dhellmann | ugh, no, I'm not going to ask you to work after work | 12:10 |
dhellmann | perhaps someone else wants to do it? | 12:11 |
*** khushbu has quit IRC | 12:11 | |
asettle | You're kind, but it's a small email | 12:11 |
dhellmann | chason, or petr? | 12:11 |
asettle | I can write it then :) | 12:11 |
dhellmann | I have a rule about that | 12:11 |
asettle | Uhh, after work stuff? | 12:11 |
dhellmann | yes, no working after work :-) | 12:12 |
dhellmann | especially no asking others to | 12:12 |
*** edmondsw has quit IRC | 12:13 | |
chason | dhellmann: Hey! o/ | 12:17 |
dhellmann | chason : o/ | 12:17 |
chason | dhellmann need some help? | 12:17 |
dhellmann | I was looking for someone to write an email to the -dev list encouraging projects to make sure their links are all added to the docs repo ^^ | 12:17 |
dhellmann | do you have some time to do that today? | 12:18 |
dhellmann | we should have enough instructions in our contributor guide now for them to start doing it on their own | 12:18 |
*** yamamoto has joined #openstack-doc | 12:20 | |
AJaeger | chason: and please don't patch it yourself ;) Let the teams learn how to do it | 12:24 |
dhellmann | right, the point is to start getting them used to the idea of maintaining this info themselves | 12:24 |
AJaeger | agreed | 12:25 |
AJaeger | 40 000 hours - that's 238 days without sleep. asettle, you should rethink how you handle your calendar ;( | 12:26 |
asettle | AJaeger: time management is not a strength of mine :P | 12:26 |
AJaeger | ;( | 12:26 |
asettle | Hhahaha okay it's just 4 hours, but still | 12:27 |
* AJaeger would love to see a review of https://review.openstack.org/#/c/488321/ and https://review.openstack.org/#/c/488338/ , please | 12:27 | |
asettle | That's a lot of back-to-back meetings | 12:27 |
asettle | God it :) | 12:27 |
asettle | Got* | 12:27 |
* setuid looks | 12:27 | |
chason | OK, I will do that after the dinner. | 12:27 |
AJaeger | thanks | 12:28 |
* AJaeger disappears to his next meeting - luckily 4h shifts only tomorrow and Wednesday | 12:28 | |
setuid | So removing (not demoting) them from sitemap, it looks like | 12:28 |
*** catintheroof has joined #openstack-doc | 12:29 | |
AJaeger | setuid: first change prios, second removes it. | 12:29 |
setuid | Wait, misread, no that's good. | 12:29 |
setuid | As long as they're _linked_ from somewhere, or in sitemap | 12:29 |
setuid | Remove them entirely, you completely orphan them off | 12:30 |
dhellmann | the more I think about that issue, the more I think we want to remove the version-specific docs and change the theme to only link to the series names | 12:30 |
dhellmann | I still don't know about the sitemap question, though | 12:30 |
setuid | So no more linking to version numbers, only series 'common names'? | 12:31 |
*** yamamoto has quit IRC | 12:32 | |
*** yamamoto has joined #openstack-doc | 12:33 | |
*** yamamoto has quit IRC | 12:33 | |
*** yamamoto has joined #openstack-doc | 12:33 | |
dhellmann | right | 12:39 |
*** thorst has joined #openstack-doc | 13:00 | |
*** rbowen has quit IRC | 13:02 | |
*** lucasxu has joined #openstack-doc | 13:02 | |
*** rbowen has joined #openstack-doc | 13:03 | |
*** khushbu has joined #openstack-doc | 13:09 | |
AJaeger | dhellmann: agreed, we can do that - link to Ocata, Pike etc - and master/latest | 13:11 |
*** edmondsw has joined #openstack-doc | 13:13 | |
*** khushbu has quit IRC | 13:13 | |
*** edmondsw has quit IRC | 13:22 | |
*** edmondsw has joined #openstack-doc | 13:22 | |
*** sekelso has joined #openstack-doc | 13:24 | |
*** gouthamr has joined #openstack-doc | 13:31 | |
AJaeger | dhellmann: I still think we should merge my changes, then stop publishing on tagging and remove the option from the theme - and then black list. These issues are unrelated | 13:37 |
dhellmann | AJaeger : ++ | 13:57 |
*** mriedem has joined #openstack-doc | 13:58 | |
dhellmann | AJaeger : https://review.openstack.org/489231 | 14:00 |
dhellmann | asettle, chason : ^^ | 14:00 |
setuid | "stop publishing on tagging", can you expand on that? | 14:00 |
dhellmann | setuid : today we publish every time a patch lands and every time we tag a release. This drops the latter job so that we only publish when we land patches. | 14:01 |
setuid | By "publish", you mean push a message to announce? or something different? | 14:01 |
*** vijaykc4 has quit IRC | 14:02 | |
setuid | I'm trying to be sure there's a process at tagging time that doesn't leave something incomplete | 14:02 |
dhellmann | documentation | 14:02 |
dhellmann | setuid : http://lists.openstack.org/pipermail/openstack-dev/2017-July/120356.html | 14:03 |
setuid | Why wouldn't you publish when you tag a release? That's the "last" version of those specific docs, no? | 14:03 |
dhellmann | why do we need to publish then? | 14:03 |
*** alexchadin has quit IRC | 14:03 | |
setuid | "These docs are now final, as this release has been retired. Here's the final copy. No further updates will ever happen on this release." yadda yadda. | 14:04 |
dhellmann | why not do that on the $series docs? | 14:04 |
setuid | That allows operators to fetch that copy, at a point-in-time when they should be able to reliably build it with current tools at the time, vs. months later when things break or need post-clone patching. | 14:04 |
openstackgerrit | Merged openstack/openstack-doc-tools master: Document installation of scrapy via pip https://review.openstack.org/479863 | 14:05 |
openstackgerrit | Merged openstack/openstack-doc-tools master: Make openstack-doc-tools can be used in the individual client repos https://review.openstack.org/487292 | 14:05 |
setuid | I'm confused, are you talking about ceasing publishing on the numbered releases, but continuing on the series names? Or stopping altogether when you tag? | 14:05 |
*** khushbu has joined #openstack-doc | 14:05 | |
dhellmann | they can still fetch the tagged repo | 14:05 |
dhellmann | I just want to not run the job when we tag. | 14:05 |
setuid | Will there ever be any commits between branch and the tag, where you create a gap? | 14:06 |
setuid | IOW, the last time you publish, and the time you tag, will there be _any_ commits in that delta? | 14:06 |
dhellmann | no, we publish when we land patches, so every patch's content is published | 14:07 |
setuid | So the very last tag on a release, would be the last publish, and so the tagged version would be byte-for-byte identical? | 14:08 |
setuid | er, very last patch on a release | 14:08 |
dhellmann | yes, that's what I would expect | 14:08 |
AJaeger | setuid: you're looking at the EOL - dhellmann is looking at the whole process that leads to it | 14:08 |
openstackgerrit | Merged openstack/openstack-doc-tools master: Change priorities for sitemap https://review.openstack.org/488321 | 14:08 |
openstackgerrit | Merged openstack/openstack-doc-tools master: Do not add EOL releases to sitemap https://review.openstack.org/488338 | 14:09 |
setuid | AIUI, a tag is a release point. If you release 2.0, you tag your code as 2.0, and nothing can change it. Then you release 2.0. That's how I've done it with projects I've maintained before. | 14:09 |
AJaeger | setuid: we currently publish on the stable/ocata branch separate docs.o.o/PROJECT/TAG documents like for 1.1 and 1.2 and 1.3 | 14:09 |
setuid | AJaeger: I'm trying to make sure the scoping is the same for all releases, whether they're eol or not... that way, eol releases fall off naturally without any gaps. | 14:09 |
*** khushbu has quit IRC | 14:10 | |
setuid | Ok, as long as what was rolled up with the last patch, is identical to what you get in a tagged clone, that's fine. | 14:10 |
dhellmann | setuid : you'll get what you clone, so if there are untagged commits and you clone a commit you could miss something. Is that what you mean? | 14:12 |
dhellmann | sorry, "clone a tag" | 14:12 |
setuid | aye, as long as I don't have to do post-tagged-clone checkout + rollup patching to get to a current state of that tag, that's fine. | 14:12 |
setuid | If I check out a tag of -manuals, I'm expecting that to be the full, complete, most-recent, patched copy of the manuals at that tag point. | 14:13 |
dhellmann | yeah, we want to make sure our EOL process includes a version tag | 14:13 |
dhellmann | oh, this change applies to all of the other repos, not manuals | 14:13 |
setuid | EOL or otherwise, I shouldn't need to patch anything in a tagged clone to get to 'current' | 14:13 |
setuid | for tip/master/HEAD, yes, of course I'll need to rebases | 14:13 |
dhellmann | like I said, you get what you clone. If you want "current" clone HEAD. If you want the tag, clone that. | 14:14 |
setuid | Right right, I think we're on the same page, just overloaded semantics :) | 14:14 |
setuid | Is the overhead in running the job at the point where you tag, just because of iops, or disk space, or duration to complete the job? | 14:15 |
dhellmann | the issue has nothing to do with the job itself. The output of the job can never be updated because we don't have a way to rebuild it. So we end up with something that, if it's broken (JS security bug, whatever) we have to just delete it by hand. | 14:16 |
dhellmann | I'm trying to eliminate edge cases that result in manual labor. | 14:16 |
dhellmann | We never refer anyone to the 10.0.1 version of the nova docs. Why are we building them? | 14:16 |
dhellmann | We used to refer people to the x.y.z version of $library docs, but why do we do *that*? The latest docs for a series should include all the info they need. | 14:17 |
AJaeger | dhellmann: in the past, we only published at tag time for libraries - and not stable/ocata. | 14:17 |
* AJaeger agrees, let's stop doing tag builds. | 14:17 | |
AJaeger | this means we need to take out the feature to link to the last versions in openstackdocstheme - and add a way to link to different branches instead. | 14:18 |
dhellmann | AJaeger : yeah, I want to rewrite that to link to branch names instead of versions | 14:19 |
setuid | I'm in agreement on dropping the numbered series builds/tagging, that makes sense. I'm just trying to understand the driver behind reducing the build jobs. I thought it was CI/CD on that end, but it seems to be triggered from the commits/tags, not continuous. | 14:19 |
dhellmann | setuid : the goal isn't to reduce the number of jobs, it's to reduce unmaintainable published content. Removing the job is a step toward not making the current situation worse. | 14:20 |
fungi | worth noting that distros have a tendency to carry somewhat arbitrary versions of libs with fixes backported, so we won't have the ability for users getting packages from them to find the exact docs on our site corresponding to the claimed version they have installed | 14:20 |
dhellmann | fungi : that's a good point | 14:21 |
fungi | this also means we're assuming all our docs are for projects which participate in the coordinated release | 14:21 |
fungi | not all projects which publish docs have stable branches, but may still have different released versions | 14:22 |
dhellmann | fungi : that's a fair point. We could add a different template for projects that want to publish on tagged releases | 14:22 |
dhellmann | although then we'd just have the same problem with those projects | 14:22 |
setuid | fungi: That could be a problem, but would require better cooperation between distributions and the openstack-core team. | 14:22 |
dhellmann | for independent projects that don't branch, they will still have /$project/latest/ | 14:22 |
setuid | Not impossible, just coordination | 14:23 |
fungi | we did have that split at one point: services were part of the coordinated release and so only published from branch tips, libraries and clients released only from their master branches and so published docs when tags were pushed | 14:23 |
dhellmann | and for independent projects that branch using non-standard names, they'll have those as series | 14:23 |
fungi | seems like we haven't changed the reasons for that split, we've just changed which kinds of projects are part of the integrated release | 14:23 |
dhellmann | yeah, that made it more difficult to release fixes for libraries that didn't require updating all of your other dependencies at the same time | 14:24 |
fungi | right, but point being we couched that split as services vs libs, when really it was projects which release from stable branches vs those which don't | 14:25 |
dhellmann | yes, true, that's a better characterization | 14:25 |
AJaeger | dhellmann: make it configurable whether to link to branches - or check for existince of our stable branches | 14:25 |
setuid | I need to dig in and understand that a bit more. Do you really have users who consume their docs from distribution packages of openstack docs? | 14:26 |
setuid | vs. going to the main website to consume them? | 14:26 |
dhellmann | AJaeger : yes, I was going to look for /stable/$name branches and $name-eol tags, sort them, then have an option to specify the first to include, with a default of mitaka or newton, depending on which we have for more projects | 14:26 |
AJaeger | sounds great | 14:26 |
dhellmann | setuid : no idea | 14:27 |
fungi | setuid: at least some of the distros do package project documentation | 14:27 |
fungi | ostensibly because some consumers may make use of the software without constant/easy access to the internet | 14:28 |
dhellmann | AJaeger : how do you feel about me adding dulwich to openstackdocstheme instead of using git through subprocess? | 14:28 |
setuid | fungi: Right, Bloomberg for example, builds their clusters in DCs without any Internet access, detached/disconnected mode. | 14:28 |
setuid | But they consume the docs from upstream, well... until recently when we had to stage them internally because they vanished upstream. | 14:29 |
fungi | my anecdote about packaged versions was more that users trying to browse docs.o.o may have a harder time finding docs for the exact versions of software from their distro if we stop publishing when tags are pushed | 14:30 |
dhellmann | yes, they would need to know what series a version is in | 14:32 |
dhellmann | maybe we should have the theme build a list "this series includes versions A, B, C" | 14:33 |
dhellmann | although the logic for that is relatively complicated | 14:33 |
*** openstackgerrit has quit IRC | 14:33 | |
fungi | especially for end-user tools, e.g if i have python-novaclient 9.1.0 installed, i won't necessarily know what release cycle that is | 14:34 |
fungi | i suppose we can tell users to look at releases.o.o to figure that out | 14:35 |
AJaeger | dhellmann: what does dulwhich drag in? | 14:35 |
dhellmann | fungi : yeah | 14:35 |
dhellmann | fungi : or we could set up redirects | 14:35 |
dhellmann | although doing that properly might also be complex | 14:35 |
AJaeger | dhellmann: so, if the overhead is low, go for it... | 14:35 |
dhellmann | AJaeger : I don't think it has a lot of external dependencies, let me see | 14:36 |
dhellmann | AJaeger : it is self-contained | 14:37 |
AJaeger | cool, go for it ;) | 14:38 |
AJaeger | bbl | 14:38 |
*** yamamoto has quit IRC | 14:45 | |
*** rcernin has quit IRC | 15:03 | |
*** pcaruana has quit IRC | 15:04 | |
*** diablo_rojo has joined #openstack-doc | 15:09 | |
*** yamamoto has joined #openstack-doc | 15:16 | |
sambetts | AJaeger: have you got a link to the docs explaining how to setup rtd for an openstack project? | 15:19 |
*** openstackgerrit has joined #openstack-doc | 15:20 | |
openstackgerrit | Doug Hellmann proposed openstack/openstackdocstheme master: show release series names not version tags https://review.openstack.org/489252 | 15:20 |
openstackgerrit | Doug Hellmann proposed openstack/openstackdocstheme master: show other versions by default https://review.openstack.org/489253 | 15:20 |
*** yamamoto has quit IRC | 15:21 | |
AJaeger | sambetts: nothing in the infra manual? | 15:26 |
AJaeger | sorry, in a meeting right now... | 15:26 |
*** lucasxu has quit IRC | 15:26 | |
sambetts | AJaeger: not that I can find, although I think I've worked it out :/ I think I just need to add docs-on-rtfd to my zuul layout and jenkins/job things | 15:31 |
openstackgerrit | Doug Hellmann proposed openstack/openstackdocstheme master: show release series names not version tags https://review.openstack.org/489252 | 15:32 |
openstackgerrit | Doug Hellmann proposed openstack/openstackdocstheme master: show other versions by default https://review.openstack.org/489253 | 15:32 |
dhellmann | sambetts : which project? | 15:33 |
sambetts | networking-cisco | 15:33 |
dhellmann | ah, right | 15:33 |
dhellmann | yes, I think you just need to add that job | 15:34 |
AJaeger | sambetts: yeah, just add those | 15:34 |
dhellmann | you may need to add it in jenkins/jobs/projects.yaml as well as zuul/layout.yaml | 15:34 |
*** khushbu has joined #openstack-doc | 15:39 | |
sambetts | AJaeger, dhellmann: thanks, I've pushed a new version of that patch using the infra hook instead of the custom method | 15:41 |
*** yamamoto has joined #openstack-doc | 15:48 | |
*** khushbu__ has joined #openstack-doc | 15:52 | |
*** khushbu has quit IRC | 15:55 | |
*** yamamoto has quit IRC | 15:58 | |
jungleboyj | dhellmann: AJaeger ... Do you guys have an experience with .. remote-code-block:: ? | 16:03 |
*** vijaykc4 has joined #openstack-doc | 16:03 | |
*** donghao has joined #openstack-doc | 16:04 | |
jungleboyj | It was in some of the documentation I pulled over and it appears to no longer work with Sphinx. Tried replacing it with .. raw:: and using :url: to get the path to the file it wanted but then I just get an unformatted stream of text. | 16:04 |
dhellmann | asettle, chason, AJaeger, doc-team: please review this release team process document update for the end-of-release steps related to documentation: https://review.openstack.org/#/c/489265/ | 16:04 |
jungleboyj | Any ideas how I can pull in a file to the build via HTTP and have it look right? | 16:04 |
dhellmann | jungleboyj : setuid was looking at some docs that used that directive,t oo | 16:05 |
dhellmann | what do you mean by "no longer works"? | 16:05 |
asettle | Thanks dhellmann | 16:05 |
AJaeger | jungleboyj: show us an example... | 16:06 |
AJaeger | (push to gerrit) | 16:07 |
jungleboyj | dhellmann: Ok. Sphinx says it is an unknown directive. | 16:08 |
dhellmann | I think that's from an extension, isn't it? | 16:09 |
dhellmann | jungleboyj : oh, yeah, it is an extension in the manuals repo | 16:09 |
dhellmann | we probably want to either publish that or use https://pypi.python.org/pypi/remotecode | 16:10 |
dhellmann | for now, maybe just include the source file locally? | 16:10 |
dhellmann | jungleboyj : what file is it pulling in? | 16:10 |
*** lucasxu has joined #openstack-doc | 16:10 | |
jungleboyj | dhellmann: https://github.com/openstack/cinder/blob/master/doc/source/configuration/block-storage/samples/api-paste.ini.rst | 16:12 |
jungleboyj | So, am I missing adding something to get that extension during setup? | 16:12 |
dhellmann | oh | 16:13 |
dhellmann | ok, here's what's going on | 16:13 |
dhellmann | in the old config guide, they couldn't use ".. include" because the file wasn't local | 16:13 |
dhellmann | in *your* config guide, you can do that, and you can use the oslo.config sphinx extension to generate that file | 16:14 |
dhellmann | so you want to replace the remote-code-block directive with a simple include and you want to enable the sample file generator as described in the oslo.config docs | 16:14 |
dhellmann | make sense? | 16:14 |
jungleboyj | Gotcha, so similar to what we do for the cinder.conf.sample | 16:15 |
dhellmann | yeah | 16:15 |
dhellmann | in fact, the results might be redundant | 16:15 |
dhellmann | oh, wait, this is api-paste, isn't it | 16:15 |
dhellmann | so forget most of what I said | 16:15 |
jungleboyj | Yeah. | 16:16 |
dhellmann | sorry | 16:16 |
dhellmann | if you have one of these sample files in your git repo, you can just use the literalinclude directive to show it | 16:16 |
dhellmann | you don't have to generate it :-) | 16:16 |
jungleboyj | Yeah, this is for api-paste.ini, policy.json and rootwrap.conf | 16:16 |
dhellmann | for policy we do have a generator | 16:16 |
dhellmann | for the others, we don't | 16:16 |
jungleboyj | Ok, so generate policy.json, point to the api-paste and rootwarap.conf that we have in the tree. | 16:17 |
dhellmann | ++ | 16:18 |
jungleboyj | dhellmann: Cool. Thanks! | 16:18 |
jungleboyj | dhellmann: The other problem that a number people are seeing is this: https://bugs.launchpad.net/oslo.config/+bug/1705245 | 16:18 |
openstack | Launchpad bug 1705245 in oslo.config "sphinxext: duplicated group names in the rendered text" [Medium,Confirmed] | 16:18 |
jungleboyj | For some of them, I think it is a case where it is building the tables and then coming back and trying to include them and it shows up as a duplicate. | 16:19 |
jungleboyj | Looks like the includes either need to be named as .inc or need to be excluded in the setup. | 16:19 |
jungleboyj | Does that make sense? | 16:20 |
*** khushbu__ has quit IRC | 16:20 | |
dhellmann | let me look at that source | 16:20 |
dhellmann | hmm, what "includes" do you mean? | 16:20 |
*** sambetts is now known as sambetts|afk | 16:21 | |
*** khushbu has joined #openstack-doc | 16:22 | |
*** khushbu has quit IRC | 16:22 | |
jungleboyj | So, for instance ... | 16:22 |
jungleboyj | Give me a minute. Need to find an example. | 16:24 |
openstackgerrit | Ian Y. Choi proposed openstack/openstackdocstheme master: Documents how to set conf.py for PDF generation https://review.openstack.org/489272 | 16:26 |
jungleboyj | https://github.com/openstack/cinder/blob/master/doc/source/configuration/block-storage/backup/ceph-backup-driver.rst tries to include: https://github.com/openstack/cinder/blob/master/doc/source/configuration/tables/cinder-backups_ceph.rst at line 45. | 16:28 |
jungleboyj | It causes a Sphinx warning about 'duplicate label cinder-backups_ceph' to be thrown. | 16:29 |
jungleboyj | dhellmann: ^^ | 16:29 |
dhellmann | jungleboyj : oh, that's not the same error as the bug you linked | 16:29 |
jungleboyj | dhellmann: Oh gosh, you are right. I am sorry. | 16:30 |
dhellmann | np. I think your solution of renaming the file being included should help | 16:31 |
dhellmann | on the other hand, you could also use oslo.config to insert the table at that point in real time | 16:31 |
dhellmann | or build time | 16:31 |
jungleboyj | dhellmann: Ok, I will give that a try. Any idea why we hadn't see this problem before? | 16:31 |
jungleboyj | dhellmann: Right, I think that is a change for the future though. Just trying to get this all working before the release and then can go back in the future and improve it. | 16:32 |
dhellmann | this is the new stuff pulled in from the manuals repo, right? | 16:32 |
jungleboyj | dhellmann: Correct. | 16:32 |
dhellmann | +1 to iterating | 16:32 |
jungleboyj | dhellmann: Good. :-) | 16:32 |
*** vijaykc4 has quit IRC | 16:33 | |
dhellmann | in the docs repo, I don't know if those table files were named something other than *.rst or if they had told sphinx to exclude the tables directory when scanning source files | 16:33 |
dhellmann | renaming is the simplest solution, though, so I'd do that if you can | 16:33 |
jungleboyj | dhellmann: Ok. Cool. I think that will also resolve a number of errors where it thinks the files are not being used. | 16:33 |
*** vijaykc4 has joined #openstack-doc | 16:34 | |
jungleboyj | dhellmann: I just wanted to make sure I had done accurate debug on the problem. Thanks for the confirmation. | 16:34 |
dhellmann | it sounds like you're right | 16:35 |
*** edmondsw has quit IRC | 16:37 | |
*** chason has quit IRC | 16:37 | |
*** chason has joined #openstack-doc | 16:52 | |
*** donghao has quit IRC | 16:58 | |
*** efoley has quit IRC | 17:24 | |
openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: address comments in contributor docs https://review.openstack.org/489282 | 17:30 |
*** tosky has quit IRC | 17:32 | |
*** emagana has joined #openstack-doc | 17:57 | |
*** vijaykc4 has quit IRC | 18:13 | |
*** rbowen has quit IRC | 18:24 | |
*** rbowen has joined #openstack-doc | 18:39 | |
*** KeithMnemonic has joined #openstack-doc | 18:42 | |
*** catintheroof has quit IRC | 18:59 | |
*** catintheroof has joined #openstack-doc | 19:00 | |
*** emagana_ has joined #openstack-doc | 19:00 | |
*** catintheroof has quit IRC | 19:00 | |
*** catintheroof has joined #openstack-doc | 19:01 | |
*** emagana has quit IRC | 19:03 | |
*** edmondsw has joined #openstack-doc | 19:30 | |
*** edmondsw has quit IRC | 19:32 | |
*** edmondsw has joined #openstack-doc | 19:32 | |
*** nicolasbock has quit IRC | 19:33 | |
*** emagana_ has quit IRC | 19:44 | |
*** annegentle has joined #openstack-doc | 19:45 | |
*** emagana has joined #openstack-doc | 19:45 | |
*** khushbu has joined #openstack-doc | 19:47 | |
*** annegentle has quit IRC | 19:49 | |
*** khushbu has quit IRC | 19:51 | |
*** annegentle has joined #openstack-doc | 20:18 | |
*** thorst is now known as thorst_afk | 20:25 | |
*** emagana has quit IRC | 20:59 | |
*** lucasxu has quit IRC | 21:02 | |
*** emagana has joined #openstack-doc | 21:04 | |
*** emagana has quit IRC | 21:05 | |
*** emagana has joined #openstack-doc | 21:06 | |
*** yamamoto_ has joined #openstack-doc | 21:06 | |
*** yamamoto_ has quit IRC | 21:15 | |
*** diablo_rojo has quit IRC | 21:15 | |
*** catintheroof has quit IRC | 21:17 | |
openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: add has_in_tree_htaccess flag to template generator https://review.openstack.org/488190 | 21:23 |
openstackgerrit | Doug Hellmann proposed openstack/openstack-manuals master: set has_in_tree_htaccess flag for nova https://review.openstack.org/489407 | 21:23 |
*** skelso has joined #openstack-doc | 21:39 | |
*** sekelso has quit IRC | 21:42 | |
*** skelso has quit IRC | 21:45 | |
*** annegentle has quit IRC | 22:15 | |
*** yamamoto has joined #openstack-doc | 22:16 | |
*** yamamoto has quit IRC | 22:23 | |
*** yamamoto has joined #openstack-doc | 22:28 | |
*** suyog has joined #openstack-doc | 22:38 | |
*** thorst_afk has quit IRC | 22:38 | |
*** gouthamr has quit IRC | 22:46 | |
*** edmondsw has quit IRC | 22:52 | |
*** furface has joined #openstack-doc | 23:07 | |
*** emagana has quit IRC | 23:13 | |
*** emagana has joined #openstack-doc | 23:15 | |
*** gouthamr has joined #openstack-doc | 23:16 | |
*** catintheroof has joined #openstack-doc | 23:24 | |
*** https_GK1wmSU has joined #openstack-doc | 23:28 | |
*** https_GK1wmSU has left #openstack-doc | 23:31 | |
*** catintheroof has quit IRC | 23:43 |
Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!