Thursday, 2017-08-03

*** masaki has joined #openstack-doc00:02
*** http_GK1wmSU has joined #openstack-doc00:11
*** http_GK1wmSU has left #openstack-doc00:11
*** gmann has quit IRC00:17
*** gmann has joined #openstack-doc00:17
*** s-shiono has joined #openstack-doc00:18
*** yangyapeng has joined #openstack-doc00:19
*** khushbu_ has joined #openstack-doc00:21
*** yangyapeng has quit IRC00:24
*** khushbu_ has quit IRC00:25
openstackgerritOpenStack Proposal Bot proposed openstack/openstackdocstheme master: Updated from global requirements  https://review.openstack.org/49025900:38
*** dmacpher has quit IRC00:56
*** khushbu_ has joined #openstack-doc01:00
*** phuongnh has joined #openstack-doc01:03
*** khushbu_ has quit IRC01:05
*** phuongnh has quit IRC01:08
*** lucasxu has joined #openstack-doc01:09
*** lucasxu has quit IRC01:10
*** phuongnh has joined #openstack-doc01:17
*** yangyapeng has joined #openstack-doc01:18
*** yangyape_ has joined #openstack-doc01:20
*** yangyapeng has quit IRC01:23
*** thorst_afk has quit IRC01:37
*** yamamoto has quit IRC01:45
*** yamamoto has joined #openstack-doc01:45
*** mriedem has quit IRC01:47
*** dmacpher has joined #openstack-doc02:04
*** ekcs has quit IRC02:06
*** yamamoto has quit IRC02:41
*** skelso has joined #openstack-doc02:47
*** sekelso has joined #openstack-doc02:49
*** yamamoto has joined #openstack-doc02:51
*** skelso has quit IRC02:52
*** sekelso has quit IRC03:03
*** gouthamr has quit IRC03:03
*** sekelso has joined #openstack-doc03:07
*** skelso has joined #openstack-doc03:09
*** sekelso has quit IRC03:13
*** nicolasbock__ has joined #openstack-doc03:14
*** khushbu has joined #openstack-doc03:22
*** khushbu has quit IRC03:27
*** yamamoto has quit IRC03:33
*** thorst_afk has joined #openstack-doc03:38
*** skelso has quit IRC03:38
*** yangyapeng has joined #openstack-doc03:39
*** yangyapeng has quit IRC03:40
*** yangyapeng has joined #openstack-doc03:41
*** yamamoto has joined #openstack-doc03:42
*** yangyape_ has quit IRC03:43
*** yangyapeng has quit IRC03:46
*** yamamoto has quit IRC03:48
*** yamamoto has joined #openstack-doc03:49
*** thorst_afk has quit IRC03:52
*** yamamoto has quit IRC03:54
*** charcol has quit IRC03:59
*** khushbu has joined #openstack-doc04:09
*** khushbu has quit IRC04:10
*** charcol has joined #openstack-doc04:11
*** khushbu has joined #openstack-doc04:16
*** khushbu has quit IRC04:29
*** khushbu_ has joined #openstack-doc04:31
*** yangyapeng has joined #openstack-doc04:43
*** yangyape_ has joined #openstack-doc04:48
*** yangyapeng has quit IRC04:51
*** vharsh has joined #openstack-doc04:59
*** khushbu_ has quit IRC05:01
*** khushbu_ has joined #openstack-doc05:04
*** khushbu_ has quit IRC05:07
*** charcol-v2 has joined #openstack-doc05:08
*** khushbu_ has joined #openstack-doc05:08
*** charcol has quit IRC05:11
*** ekcs has joined #openstack-doc05:20
*** charcol-v2 has quit IRC05:22
openstackgerritMerged openstack/openstackdocstheme master: Updated from global requirements  https://review.openstack.org/49025905:29
*** ekcs has quit IRC05:37
*** robcresswell has quit IRC05:41
*** thorst_afk has joined #openstack-doc05:49
*** dims has quit IRC05:52
*** thorst_afk has quit IRC05:53
*** dims has joined #openstack-doc05:54
*** ujuc has joined #openstack-doc05:54
*** larainema has quit IRC05:56
openstackgerritAndreas Jaeger proposed openstack/openstack-manuals master: Add some redirects  https://review.openstack.org/49018506:16
*** seongsoocho has quit IRC06:17
*** seongsoocho has joined #openstack-doc06:18
*** rcernin has joined #openstack-doc06:19
*** alexchadin has joined #openstack-doc06:24
*** andreas_s has joined #openstack-doc06:27
*** vharsh has quit IRC06:38
*** ujuc has quit IRC06:39
*** ujuc has joined #openstack-doc06:45
*** pcaruana has joined #openstack-doc06:48
*** suyog has quit IRC06:49
*** vharsh has joined #openstack-doc06:50
openstackgerritOpenStack Proposal Bot proposed openstack/openstack-manuals master: Imported Translations from Zanata  https://review.openstack.org/49035707:00
openstackgerritOpenStack Proposal Bot proposed openstack/openstack-manuals stable/ocata: Imported Translations from Zanata  https://review.openstack.org/49036207:09
*** Dinesh_Bhor has quit IRC07:10
*** Dinesh_Bhor has joined #openstack-doc07:16
*** tesseract has joined #openstack-doc07:17
*** thorst_afk has joined #openstack-doc07:22
*** thorst_afk has quit IRC07:27
*** khushbu_ has quit IRC07:32
*** jpena|off is now known as jpena07:39
*** robcresswell has joined #openstack-doc07:42
openstackgerritMerged openstack/openstack-manuals master: Imported Translations from Zanata  https://review.openstack.org/49035707:42
*** khushbu has joined #openstack-doc07:48
*** larainema has joined #openstack-doc07:54
openstackgerritDebo Zhang proposed openstack/openstackdocstheme master: Update links in README  https://review.openstack.org/49037307:55
*** efoley has joined #openstack-doc08:02
*** openstackgerrit has quit IRC08:18
*** dmacpher has quit IRC08:21
*** phuongnh has quit IRC08:24
*** phuongnh has joined #openstack-doc08:27
*** yangyapeng has joined #openstack-doc08:27
*** yangyap__ has joined #openstack-doc08:29
*** yangyape_ has quit IRC08:32
*** yangyapeng has quit IRC08:32
*** vharsh has quit IRC08:37
*** beekhof has left #openstack-doc08:45
*** vharsh has joined #openstack-doc08:51
*** ujuc has quit IRC08:58
*** ujuc has joined #openstack-doc08:58
*** masaki has quit IRC09:02
*** dims has quit IRC09:04
*** dims has joined #openstack-doc09:08
*** openstackgerrit has joined #openstack-doc09:11
openstackgerritMark Korondi proposed openstack/training-guides master: Workflow - Replace inconsistent screenshots with selectable code snippets.  https://review.openstack.org/48976009:11
*** alexchadin has quit IRC09:15
asettleAJaeger: how do we want to tackle bugs like this: https://bugs.launchpad.net/neutron/+bug/170839409:16
openstackLaunchpad bug 1708394 in neutron "Some URL in neutron's documentation cannot found(404)." [Undecided,New]09:16
asettleI've moved it over to the neutron team09:16
asettleSince that seems most appropriate09:16
*** ujuc has quit IRC09:21
*** edmondsw has joined #openstack-doc09:22
*** thorst_afk has joined #openstack-doc09:23
*** sdague has joined #openstack-doc09:25
*** thorst_afk has quit IRC09:28
*** s-shiono has quit IRC09:33
asettlestephenfin: just an FYI - https://bugs.launchpad.net/openstack-manuals/+bug/170804409:34
openstackLaunchpad bug 1708044 in openstack-manuals "nova admin guides missing, in new openstack docs structure" [Undecided,New]09:34
*** sambetts|afk is now known as sambetts09:38
*** yamamoto has joined #openstack-doc09:41
*** tosky has joined #openstack-doc09:47
*** strigazi_OFF has quit IRC09:49
*** strigazi_OFF has joined #openstack-doc09:50
chasonstephenfin, asettle I have proposed two patches. The one is for the Nova Install Guide, another is for Admin Guide.09:54
chasonhttps://review.openstack.org/#/c/477488/09:55
chasonhttps://review.openstack.org/#/c/477497/09:55
openstackgerritAndreas Jaeger proposed openstack/openstack-manuals master: Regenerate sitemap  https://review.openstack.org/49040809:56
AJaegerasettle: agreed09:56
*** yangyap__ has quit IRC09:56
AJaegerasettle: for some of these we might need to add redirects as I did with https://review.openstack.org/490185 - but not for these specific ones09:57
*** yangyapeng has joined #openstack-doc09:57
openstackgerritMark Korondi proposed openstack/training-guides master: Workflow - Replace inconsistent screenshots with selectable code snippets.  https://review.openstack.org/48976009:57
*** yangyape_ has joined #openstack-doc10:00
*** yangyapeng has quit IRC10:01
*** yangyapeng has joined #openstack-doc10:12
asettleAJaeger: looking10:14
asettleAh I see10:14
asettlehttps://review.openstack.org/#/q/status:open+(project:+openstack/openstack-manuals+OR+project:openstack/openstackdocstheme+OR+project:openstack/api-site+OR+project:openstack/security-doc)10:15
asettleWell you guys went to town again :p10:15
*** yangyape_ has quit IRC10:15
AJaeger;)10:15
asettleI always wake up to such fun10:15
AJaegerasettle: http://paste.openstack.org/show/617316/ is list of yesterday's 404s - so I wanted to get that list smaller...10:16
AJaegerThe redirect change addresses items 1-4, 6,7,9,12...10:16
asettleI just paled10:18
asettleMy word10:18
asettleThat's a lot10:18
asettleMy browser is attempting to shut down on me10:18
AJaeger:(10:19
AJaegerasettle: regarding release notes: Yes, we need to add lot more content ...10:19
asettleAJaeger: yeah just saw and approved :) happy to merge on the basis of 404's10:23
asettleBut yep, WAY more context :P10:23
AJaeger;)10:23
*** yangyapeng has quit IRC10:25
asettleAJaeger:  I can't wait for the day when the words 'sitemap' and '404s' don't come up :P10:28
AJaeger;)10:30
* AJaeger regenerated the sitemap - do you want to +2A https://review.openstack.org/490408 ? ;)10:30
asettleYour wish is my command10:30
AJaegerthanks10:31
openstackgerritMerged openstack/openstackdocstheme master: Update links in README  https://review.openstack.org/49037310:36
asettleOkay, I think there's a few more to merge when dhellmann comes in10:36
asettleAnything you want done asap?10:36
AJaegerasettle: nothing urgent, thanks10:37
asettleNeat :)10:37
openstackgerritMerged openstack/api-site master: Update requirements for Pike  https://review.openstack.org/49010310:39
openstackgerritMerged openstack/security-doc master: Update requirements for Pike  https://review.openstack.org/49010210:39
openstackgerritMerged openstack/openstack-manuals stable/ocata: Imported Translations from Zanata  https://review.openstack.org/49036210:39
openstackgerritMerged openstack/openstack-manuals master: Remove reno, add pike releasenotes  https://review.openstack.org/48629510:39
openstackgerritMerged openstack/openstack-manuals master: Regenerate sitemap  https://review.openstack.org/49040810:40
openstackgerritMerged openstack/openstack-manuals master: Update doc-tools-check-languages.conf  https://review.openstack.org/49010010:40
AJaegernice ^ ;)10:40
*** phuongnh has quit IRC10:40
*** khushbu has quit IRC10:44
*** khushbu has joined #openstack-doc10:47
openstackgerritMerged openstack/openstack-manuals master: Add some redirects  https://review.openstack.org/49018510:47
AJaegerasettle: not urgent, just for completeness if time permits: https://review.openstack.org/49013610:48
asettleGot it :)10:48
asettleIt's all fairly easy merges10:48
asettleYou want a @a?10:48
asettle2a?10:48
openstackgerritMerged openstack/api-site master: Update doc-tools-check-languages.conf  https://review.openstack.org/49013710:49
*** ujuc has joined #openstack-doc10:49
AJaegerasettle: Let's wait for second +2...10:50
sdaguedhellmann / asettle ... what is missing from the nova docs tree to get the page toc in the sidebar like glance?10:50
sdaguehttps://docs.openstack.org/glance/latest/user/signature.html10:50
AJaegersdague: you should have it - strange.10:51
AJaegersdague: do you have a current change to double check?10:51
AJaegersdague: you have it at https://docs.openstack.org/nova/latest/ - just scroll down10:52
asettlesdague:10:52
-asettle- .. toctree::10:52
-asettle- :maxdepth: 110:52
asettleGlance uses a depth of '2'10:52
AJaegeryour top-level entry is too large10:52
asettleJust one thing I notcied10:52
sdagueAJaeger: hmmm... I didn't see it on other pages, but I do see it now, interesting10:52
AJaegersdague: you only see it if there's more than one title10:53
sdagueAJaeger: I'm not sure I understand that? 10:53
sdagueAlso, could we get the page toc at the top? That's more likely to be relevant to the user on the page10:54
AJaegersdague: check https://docs.openstack.org/nova/latest/user/support-matrix.html10:54
AJaegerIt has no toc since it has no sections10:54
*** ujuc has quit IRC10:54
sdagueAJaeger: ah, sure10:54
*** nicolasbock__ has quit IRC10:54
sdagueasettle: where should the toctree:: depth be set? I guess it's unclear to me on what things affect the sidebar10:58
asettleindex.rst within /doc/source/10:58
asettleI'll show you glance's file: https://github.com/openstack/glance/blob/master/doc/source/index.rst10:59
asettleIf you're ever interested to find out the differences between how glance vs. nova looks, RST is a pretty easy read :)10:59
asettleThe source code will usually tell you10:59
asettleSo, for nova: https://github.com/openstack/nova/blob/master/doc/source/index.rst10:59
asettleYou'd do teh same10:59
asettleI imagine stephenfin could fix that in his patch :)11:00
sdagueyeh, I'm pretty familiar with RST :) I did write the extension for the api-ref site. Just where which directive triggers the sidebar wasn't jumping out to me11:01
asettleEasy as then :) and totally understandable. The config for the toc can often be confusing and annoying (and then occasionally, doesn't work - ugh!)11:01
sdagueit also appears that my docs env was out of date, and that the sidebar flip was a new openstackdocs theme11:01
asettleBtu that should be you go :) if not, lemme know and i'll pull it down and have a poke around11:01
AJaegersdague: yes, the most recent openstackdocstheme added that11:01
asettleAhh, well that explains that :p11:02
openstackgerritMerged openstack/training-guides master: Update requirements for pike  https://review.openstack.org/49011711:10
sdagueok... just to understand the relationships here11:12
sdaguethe reason we have a giant sidebar toc is because everything has toctree stanzas in index.rst11:13
openstackgerritAndreas Jaeger proposed openstack/openstack-manuals master: [contributor] Fix glossary link  https://review.openstack.org/49042411:13
asettlesdague: yep. That was one of the reasons, when I did my patch with stephenfin , that I was nesting things further11:14
asettleOf course I understand you didn't like the full approach, but it was a suggestion. I have found, in my experience, that this works better in the long run.11:14
sdaguewe get one additional level shown here https://docs.openstack.org/nova/latest/contributor/testing.html because some sphinx magic?11:14
asettleAnd also clears up the toc's11:14
asettleLemme have a lookie11:14
openstackgerritMerged openstack/training-guides master: Workflow - Replace inconsistent screenshots with selectable code snippets.  https://review.openstack.org/48976011:15
openstackgerritAndreas Jaeger proposed openstack/openstackdocstheme master: Fix glossary links, use https  https://review.openstack.org/49042511:15
asettlesdague: not quite magic. It's opening up each level as you are technically *on* that page. If you click on 'feature classification' it'll do teh same thing11:15
sdagueasettle: sure, but if you also have the page contents sidebar it seems confusing to half do it in one place, then fully in another11:16
asettlesdague: yes, I agree. We just implemented this feature, so I imagine that's something we could improve upon. Perhaps you could help? :)11:17
asettleDoes seem very redundant11:17
openstackgerritAndreas Jaeger proposed openstack/openstackdocstheme master: Remove navigation.html  https://review.openstack.org/49042511:19
sdagueyeh, well trying to get my head around how all the pieces fit together11:20
asettlesdague: no problem. We're bound to run into bugs. It's good we're finding them :)11:20
asettleI'm trying to find the patch that implemented the toc change11:20
asettlechanges*11:20
asettleI think my brain is hungry cause I can't see it -.-11:21
sdagueactually, I'm also super confused about why nova team process shows up in the toc twice her e- https://docs.openstack.org/nova/latest/contributor/process.html11:21
sdagueyeh, well the patch I didn't like was more about splitting up things like that process document into smaller docs, which won't help the toc problem I don't think11:21
sdaguedid something change in sphinx recently around parsing for when content gets thrown into call out blocks?11:27
sdaguehttps://docs.openstack.org/nova/latest/reference/api-microversion-history.html - example11:28
sdaguebut also https://docs.openstack.org/nova/latest/contributor/process.html11:28
sdagueoh, you know what it is, it's just the new style11:28
sdaguethat's making that all much much bigger with the vertical line11:29
sdagueoof, there is a bunch of clean up of errant white space here11:29
openstackgerritAndreas Jaeger proposed openstack/openstack-manuals master: [contributor] Fix glossary link  https://review.openstack.org/49042411:29
stephenfinsdague: If you do those cleanup patches, can you tag em with doc-migration or whatever so we can see them?11:31
sdaguestephenfin: can I tag them bp: doc-migration and it will do it?11:31
sdaguestephenfin: well, lets see11:32
sdaguethat will at least keep the topic bp/doc-migration so I can have branches in parallel11:32
stephenfinYou can't - we don't have a doc-migration bp in nova11:34
stephenfinGit review will do the magic if you use a 'doc-migration' branch tho11:34
stephenfinsdague: ^11:34
sdaguestephenfin: yes, then I have to have one local branch11:35
sdaguewhich isn't going to work here11:35
sdaguebp: doc-migration11:35
sdaguedoes work11:35
sdaguethe gerrit topic setting works independent of verifying the blueprint11:35
sdagueso that is a stable tag regardless of branch / git review -d and the like11:35
stephenfinbut that sets the topic as 'bp/doc-migration' and not 'doc-migration', no?11:35
sdagueyes11:36
sdaguebut that's going to be the only way to have a stable topic11:37
stephenfinEh, fair enough. I personally use 'git review -fy' when I'm done with something and pull in only the branch I'm working on, but whatever works11:38
sdagueyeh, I expect the git review -d on quick fixes by various people is going to scramble that often enough to be less useful11:39
sdaguealso, this is actually a big enough effort, a blueprint wouldn't be a terrible idea11:40
openstackgerritAndreas Jaeger proposed openstack/openstack-manuals master: [contributor] Fix glossary link  https://review.openstack.org/49042411:44
*** yangyapeng has joined #openstack-doc11:45
*** rabel has joined #openstack-doc11:47
openstackgerritAndreas Jaeger proposed openstack/openstack-manuals master: [contributor] Fix glossary link  https://review.openstack.org/49042411:48
*** yangyapeng has quit IRC11:48
*** yangyapeng has joined #openstack-doc11:49
*** khushbu has quit IRC11:57
openstackgerritAndreas Jaeger proposed openstack/openstack-manuals master: Add hacking to indices and redirects  https://review.openstack.org/49044511:58
*** thorst_afk has joined #openstack-doc12:03
asettlesorry sdague I ran away just now to grab some food. Forgot to put an away message up12:08
AJaegerasettle: and I pushed some more fixes up for 404s ^12:09
asettleThanks, got 'em12:10
AJaegerasettle: food is a good idea - bbl12:10
asettleo/12:10
*** ownedge has joined #openstack-doc12:11
openstackgerritMerged openstack/openstack-manuals master: [contributor] Fix glossary link  https://review.openstack.org/49042412:16
*** skelso has joined #openstack-doc12:18
*** sekelso has joined #openstack-doc12:20
*** skelso has quit IRC12:23
asettlesdague and stephenfin - regarding concerns earlier about the lengthy ToC - I'd be happy to pull down https://review.openstack.org/#/c/478485/17 and have a crack at minimalising it. This does mean there will be nesting, but I won't break up the files like I did previously12:27
asettleAddressing that concern here would probably be the best/easiest way forward.12:27
asettleAlso, think it might be worth merging that patch and this one: https://review.openstack.org/#/c/490088/112:28
asettleSince they are addressing the same file, and to save on major merge conflicts...12:29
*** catintheroof has joined #openstack-doc12:36
*** ujuc has joined #openstack-doc12:37
*** ujuc has quit IRC12:42
*** jpena is now known as jpena|lunch12:44
*** dmacpher has joined #openstack-doc12:46
asettleokay stephenfin pulling down https://review.openstack.org/#/c/478485/ now12:53
stephenfinasettle: (y)12:53
*** khushbu has joined #openstack-doc12:54
stephenfinBefore you merge though, sdague - you happy to rework that file to clean up the ToC12:54
stephenfin?12:54
stephenfinTbh, I thought the conclusion was that we weren't doing any refactoring in Pike12:54
asettleI pinky promise there will be nesting :P there's no real other way to do it.12:54
asettleNot huge refactoring, but I think it'll be beneficial to have a *slightly less* confusing ToC12:55
asettleThen you can dive in afterwards12:55
asettleJust cleaning up the front page, nest it one layer lower, that way your users can navigate and not be too affronted12:55
asettleIt is just a suggestion, of course :)12:55
*** emagana has joined #openstack-doc12:56
*** khushbu has quit IRC12:58
*** skelso has joined #openstack-doc13:01
*** sekelso has quit IRC13:01
stephenfinasettle: So everything under 'user' to 'user/index', etc.?13:01
asettleYep, that's what I'm thinking.13:02
asettleIf you'd like to do that, have a go. I mean, we can always revert.13:02
dhellmannasettle, AJaeger, stephenfin : o/13:03
asettleYo yo morning13:03
sdagueso before we just start changing the toc, it would be nice to write out an information design for how we want people experiencing this thing, as well as what we think the most useful parts to put front and center are13:04
sdaguelike etherpad it13:04
stephenfinsdague: Is that not what the docs-migration spec is for?13:04
sdaguestephenfin: that's just explaining the distinction between user, configuration, reference right?13:05
asettlesdague: not necessarily. We defined what they were, because we want those to be up front and centre.13:05
asettleThey are what we consider important sections.13:05
asettleWithin those, you can introduce what is contributor information, and lay it all out13:05
sdagueI mean specific to nova. Like it's not really clear to me why that RPC doc would ever be in the toc.13:06
*** yamamoto has quit IRC13:06
sdagueasettle: right, so I want to have the conversation before code on organizational structure because I don't think gerrit is a great discussion medium for those kinds of changes13:07
stephenfinsdague: So we've moved all the docs to a section13:07
stephenfin*various sections13:07
stephenfinNow, those sections aren't necessarily correct13:07
*** emagana has quit IRC13:07
stephenfinSome because I misjudged them, and others because they're probably docs that should be split into multiple sections13:08
asettleAn example is horizon: https://docs.openstack.org/horizon/latest/13:08
stephenfinHowever, I was under the impression that we didn't want to do any major refactor this late in the cycle13:08
stephenfinand we were just going to have to live with oddly placed docs until Queens13:08
asettleWhich would make sense. Seeing as there is a lot of work to be done here - and a plan would be a good idea.13:08
asettleHowever, I am just suggesting that perhaps we address the giant ToC issue, so we don't end up with a lot of very confused users.13:09
asettlePerhaps, sdague and stephenfin - we could organise a time at the PTG to sit down and have a planning session on how to organis this?13:09
stephenfinAt that point, an etherpad or similar (and having someone from docs on board) would make definitely sense13:09
stephenfinasettle: (y)13:09
asettleI will come in as the info dev, and give you my best guidance and advice on how to manage your documentation, and you can both guide me on what is important13:09
asettleOkay, let's do. stephenfin could you add a note to: https://etherpad.openstack.org/p/denver-doc-PTG13:10
asettleWhat day is nova doing sessions? At the Atlanta PTG, I went into the glance and DNS team sessions and sat down with the team13:10
asettleOr we could find a time to do it outside of those confines.13:10
asettleSo far, we're looking like we're going to have a busy 2 days with the stuff we have so far.13:10
asettleBut I'm avail Wed - Fri13:11
*** lucasxu has joined #openstack-doc13:11
stephenfinasettle: Done. I don't know what my schedule is yet but will closer to the time13:12
asettleSweet. I know what you look like, also you're incredibly tall, so I'm sure I'll find you in a crowd to chat about a good time13:12
asettleThat sounded weirded than it did in my head.13:12
stephenfinsdague: Does that make sense? (Resolve the ToC issue now. Work on restructuring issues in Queens once we've got a PoA in place)13:13
sdaguestephenfin: I definitely agree it's important to have a less confusing ToC at this release, I still think that it impacts the whole of any restructuring, so is still worth writing down the changes conceptually and not just starting with a gerrit patch13:16
asettlesdague: if we're only looking at a top level change right now (and not going any further) then the change in gerrit would adequately reflect the build changes better than a etherpad would. I, personally, find the action of showing the changes a little easier to digest. We could start an etherpad with the minimal ToC we propose in the change now, and build down from there13:21
*** pblaho has quit IRC13:22
asettleHere's something we can get started with: https://etherpad.openstack.org/p/nova-doc-restructure13:22
*** mriedem has joined #openstack-doc13:24
stephenfinasettle: What's the deal with not needing copyrights anymore?13:27
stephenfinWhat does the theme do that makes them unnecessary?13:27
asettleGood question, trying to find it for you.13:29
asettleI thought we had something down for it13:29
asettlehttps://github.com/openstack/openstackdocstheme/blob/master/LICENSE13:29
asettleLines 124, there's no requirement to have your own copyright statement13:29
asettleYou can chose to do so or not. It's just bulky, imho. So, entirely up to you.13:30
asettlestephenfin: also I forgot, that ToC is going to be *even worse* once we introduce the installa nd admin patches13:34
asettleAlright, everything is typed out13:34
asettleFor what we have13:34
*** pblaho1 has joined #openstack-doc13:36
*** skelso has quit IRC13:40
*** skelso has joined #openstack-doc13:40
*** pblaho1 is now known as pblaho13:41
*** ujuc has joined #openstack-doc13:43
*** jpena|lunch is now known as jpena13:46
*** khushbu_ has joined #openstack-doc13:50
*** khushbu_ has quit IRC13:55
asettlestephenfin: so, I included the (to be merged) install and admin as examples in the etherpad13:58
asettleWhat that does is put everything down one level, so when it's generating the toc, it's laying out everything on that level you see there13:58
asettlesdague: I see you've got it open too, this should hopefully help with teh visuals13:58
setuidWhat is wrong with this construct: .. title:: OpenStack Installation Guide14:04
dhellmannsetuid : what error do you see?14:05
setuidIt's flagged as missing a required argument in 'doc/install-guide/source/index.rst'14:05
setuidERROR: Error in "title" directive14:05
*** pblaho has quit IRC14:05
openstackgerritMerged openstack/openstack-manuals master: Add hacking to indices and redirects  https://review.openstack.org/49044514:06
*** yamamoto has joined #openstack-doc14:06
openstackgerritOpenStack Proposal Bot proposed openstack/security-doc master: Updated from openstack-manuals  https://review.openstack.org/49049214:07
*** dustins has joined #openstack-doc14:07
setuid1 argument(s) required, 0 supplied.14:07
setuid.. title::14:07
dhellmannsetuid : is that actually the directive being parsed? at one point some of the build steps modified the title to insert the platform, maybe that modification step is going bad?14:07
setuidNot sure, I'm just running 'tox -e docs -r' inside the mitaka-eol tag14:07
setuidWorked with liberty (mvn+tox), not trying mitaka, fails14:08
setuids/not/now/14:08
*** vharsh has quit IRC14:09
*** annegentle has joined #openstack-doc14:09
dhellmannI'd have to look through the build log to see if it's trying to update the title14:09
setuidI think I'm still in this mountain of 400 dependency version hell though, I need to downgrade to build liberty, then upgrade some (but not all) to build mitaka, it's kind of a mess14:09
AJaegersetuid: the Install Guides are build by a script, are you using that?14:10
openstackgerritMerged openstack/openstack-doc-tools master: Cleanup doc-tools-check-languages  https://review.openstack.org/49013614:10
sdagueasettle: ok, be patient with me as I'm trying to come up to speed to be helpful.14:10
setuidAJaeger: I'm just following the build instructions, tox -e docs14:10
AJaegersetuid: yeah, it should...14:10
setuidAJaeger: And I see it's calling 'build-all-rst.sh', which I can run manually and fails in the same way14:10
asettlesdague: no problem. If it is helpful, we could jump on a meeting with stephenfin and I can take you through what I know :)14:10
setuidI'm going to rip out every single pip module and install from scratach14:10
asettlesetuid: you go girl14:10
AJaegersetuid: might have aborted earlier, so what's output of "git status"?14:11
sdagueasettle: yeh, I'd do that.14:11
AJaegersetuid: make sure you have a clean tree...14:11
asettlesdague: cool, I have some time this afternoon if you do - if not, we can find a time that works :)14:11
sdagueI guess the thing I'm trying to figure out, sphinx gets really grumpy if you don't add every file to a toc somewhere14:11
asettlesdague: sphinx is a PITA14:11
*** yamamoto has quit IRC14:11
sdaguebut, honestly, much of the time it's fine not to have things in the TOC14:12
AJaegersetuid: I would have thought you just use "tox -e install-guide-ubuntu" ;)14:12
sdagueat least they way I experience html sites, deep pages are totally legit for details14:12
AJaegersetuid: note that the mitaka documents are all on our website, so why rebuilt?14:12
setuidAJaeger: I run 'git clean -f -x -d' between invocations14:12
AJaegerok14:12
sdagueand that was my thinking on first round of this, was just remove things from the toctree so only the most important things are there, and it's fine if there are other deep pages that get linked to14:13
asettlesdague: yep, that's basically where my head is at.14:13
setuidAJaeger: $ git status14:13
setuidHEAD detached at mitaka-eol14:13
openstackgerritMerged openstack/security-doc master: Updated from openstack-manuals  https://review.openstack.org/49049214:14
*** ujuc has quit IRC14:14
asettleokay sdague when do you have some time? I'm on a call at the moment, but I'll be done in about 10 mins14:18
asettleWe can sit down and figure it out. stephenfin you got some free time?14:18
stephenfinI'm booking flights for the PTG, but should be free in ~20 mins14:19
stephenfinasettle: *14:19
stephenfin* ^14:19
asettleWorks for me, gives me time to grab some team14:19
asettletea*(14:19
asettleI can give you guys the link to my Rackspace conf call14:21
sdaguesure, 20 minutes would be fine14:21
asettleOkay, I'll PM you both with a link for 20 minutes time14:22
*** lucasxu has quit IRC14:22
dhellmannsetuid : the mitaka-build branch in https://github.com/dhellmann/openstack-manuals builds for me on 16.04.2 using python 2.714:23
dhellmannsetuid : I ran "tox -e docs" and "tox -e publishdocs" separately and both passed14:23
dhellmannthere are a couple of patches in that branch on top of the mitaka-eol tag, but I think both are changes you and I have already discussed14:24
*** thorst_afk has quit IRC14:30
*** skelso has quit IRC14:32
*** skelso has joined #openstack-doc14:32
*** thorst_afk has joined #openstack-doc14:32
setuidI just ripped out every pip package installed that was non-core, installed tox 2.3.1, matching my Linux machine, and rebuilt. Dies in the same place. One of these packages is parsing that header incorrectly, and I can't figure out which of the pile in this monstrous tree of modules, that it is14:33
setuidI'm building natively on both Linux and Mac14:33
setuidI know I'm a squeaky wheel, but it can't possibly require this much upgrade/downgrade/force/reset/clean/reinstall to just build the docs14:34
stephenfinsetuid: What pbr version is it using?14:35
setuid1.8.0 on Linux, not installed on Mac. I'm installing a matching version now.14:36
openstackgerritMerged openstack/openstackdocstheme master: Documents how to set conf.py for PDF generation  https://review.openstack.org/48927214:36
*** thorst_afk has quit IRC14:37
setuidstephenfin: Fails in exactly the same way14:42
setuidI'm going to pull my Linux package versions and inject them onto the Mac, it's definitely something subtle. There's 390 modules to consider here for this one build.14:42
*** thorst_afk has joined #openstack-doc14:42
*** yamamoto has joined #openstack-doc14:47
*** yamamoto has quit IRC14:47
*** ownedge has quit IRC14:53
*** ujuc has joined #openstack-doc14:53
*** thorst_afk has quit IRC15:00
*** shaunm has joined #openstack-doc15:01
*** thorst_afk has joined #openstack-doc15:01
stephenfinsetuid: I'm assuming a lot of those are to do with the package itself and not the docs15:20
stephenfinafaict, most docs builds also install the package and all its deps15:20
stephenfinfor reasons of sphinx-autodoc and the likes15:20
*** annegentle has quit IRC15:23
setuidstephenfin: The issue is that it's impossible to get 390 pip packages aand their hundreds of sub-dependencies of the exact correct versions to parse the doc syntax correctly, and then add the requirement to rip all of those out and replace them with older/newer versions if you're building from other tags.15:23
setuidIt's a HUGE roadblock to building these docs in any repeatable, clean way (think CI)15:23
*** dmacpher has quit IRC15:24
AJaegersetuid: the install guide uses some sed call to update the title based on the guide - so might be that sed does something wrong for you15:24
setuidMy Mac just finished installing all of the same pip packages, by version, as on my working Linux machine15:24
AJaegersetuid: those docs are always build in a CI ;)15:24
setuidAJaeger: The two resulting files are -identical- between my Mac clone and my Linux clone15:24
*** annegentle has joined #openstack-doc15:24
setuidIt's something deep under the hood of these packages15:25
setuidAJaeger: I started by pulling the upper-constraints.txt, using those versions, but it fails somewhere in the same parsing stack with those deps15:27
setuidhttp://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/mitaka15:27
setuidOk, it just failed on Mac, with the exact same numbered dependencies as my working Linux machine15:30
asettlesdague stephenfin : https://review.openstack.org/#/c/477488/ and https://review.openstack.org/#/c/477497/15:31
setuidInteresting, looks like some of the errors are red-herrings, masking the underlying problem. Barfed on the title parsing again, but I ran the build-all-rst.sh directly and it complained that sphinx-mark was missing, installed that, re-ran tox, failed in the same way, ran the script again, told me that openstackdocstheme was missing, installed that, now it's building again.15:34
setuidOk, now it fails in the same way.. https://paste.debian.net/hidden/f6661bba/15:35
*** skelso has quit IRC15:39
dhellmannsetuid : remind me again why you're building on the mac?15:39
*** skelso has joined #openstack-doc15:39
asettle2 cents: lots of people use macs15:39
dhellmannlots of people use lots of things. how much do we support?15:40
asettleUsually linux, and by extension, mac - simply because it's unix as well. Windows - not really ever15:41
asettleI would say it's fairly unsustainable to only support linux15:42
dhellmannthe versions of some of the tools used in our shell scripts vary between linux and mac, so we may have to rewrite those if we want to formally claim macos support15:42
dhellmannsed is one of those15:43
AJaegerdhellmann: mac os was always best effort - so we take patches that somebody submits...15:43
AJaegerbut we do not test mac...15:43
sdagueasettle: cool... stephenfin are you going to rebase those - https://review.openstack.org/#/c/477488/ and https://review.openstack.org/#/c/477497/15:44
dhellmannthat's fine, I don't object to supporting it, I'm just pointing out that in this case we know the build works on linux and it's failing on mac, so I want to make sure we're not throwing a bunch of effort into something we don't have to15:44
*** sambetts is now known as sambetts|afk15:45
AJaegerdhellmann: agreed. Our CI is on Linux etc - so if somebody runs in problems on Mac, let them test on Linux first...15:47
*** yamamoto has joined #openstack-doc15:48
*** andreas_s has quit IRC15:48
setuidIt's easier and faster to configure, deploy and stand up openstack itself, than it is to build the docs that are needed to support that same environment. Sigh.15:49
AJaegersetuid: it's not - for everybody else here it's the opposite ;)15:50
*** yamamoto has quit IRC15:53
AJaegersetuid: sorry to hear that from you, I'm really surprised that we test this in CI - and mitaka was in CI until just a few weeks ago on Ubuntu and it fails for you ;(15:54
setuidMy biggest complaint is the amount of meticulous package surgery and repository patching it needs to build cleanly15:56
setuidIt's _very_ fragile15:56
setuidI've never, in my entire career, met a single codebase that required so much hand-holding to build15:56
dhellmannsetuid : the problem is in the difference in behavior between grep and sed on linux and ubuntu15:58
dhellmannbuild-install-guides-rst.sh is trying to pull a title string out of the index.rst for the install guide, and getting an empty value15:58
setuidIt appears to work, on Linux, when you have all of the specific packages downgraded/injected, after patching15:59
dhellmannline 39 of the file15:59
stephenfinsdague: I am, yeah. Just finishing up now15:59
setuiddhellmann: So you think it's not in the pip packages at this point, but in the OS-provided sed/awk'isms?15:59
dhellmannto get this branch to build on linux I applied 1 patch to fix obsolete urls. What else have you had to do?15:59
dhellmannsetuid : yes, it has noting to do with the python stuff15:59
AJaegersetuid: I see change I63fc0fd0c8afde883ffaf69c9b674c88d807901415:59
AJaegerhttps://review.openstack.org/#/c/364404/ - might solve your problem16:00
dhellmannsetuid : http://paste.openstack.org/show/617456/16:01
setuidOne sec, I'll give that a test... juggling a handful of code/cats here16:02
setuid(not literally cats)16:02
dhellmannsetuid : remove the "-m 1" argument from the grep command16:02
*** khushbu has joined #openstack-doc16:02
ianychoiOh that's my patch - applying the patch should work on MacOS environment16:03
setuidI went down the wrong dungeon, chasing pip version/dependencies, not OS portability issues16:05
*** khushbu has quit IRC16:07
*** thorst_afk has quit IRC16:08
ianychoiI have just 1) cloned mitaka-eol, 2) did the same change as 364404, and 3) executed $ tox -einstall-guides and it works well16:09
ianychoi(on my MacOS environment)16:09
setuidI'm not a fan of that snaggly pipelining, but once I wrap my head around how this tree builds, all of the various nested tools, I'll submit some portability patches/fixxes.16:10
*** rcernin has quit IRC16:12
ianychoiIn my honest opinion, it would be also great if upper-constraints.txt or test-requirements.txt in the repository might be changed (e.g., the using version) before tagging as eol - for example, I see "deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed"), but not sure whether it would be so great idea or not with wider view in OpenStack.16:12
setuidianychoi: add it to the list! https://etherpad.openstack.org/p/doc-future-problems16:14
ianychoisetuid, sorry I don't know what you are doing but I am now just sharing my experience by seeing this channel :)16:14
setuidConfirmed, that minor fix allows docs to complete clean on Mac16:15
*** thorst_afk has joined #openstack-doc16:15
ianychoisetuid, oh you are doing some important things :)16:15
ianychoiThank you for sharing the Etherpad16:16
AJaegerianychoi: that etherpad is where dhellmann, asettle, et al put out all the issues we found while migrating docs16:21
setuid^^ this16:21
ianychoiAJaeger, aha I see. I admit that recently I have not seen all the messages in this channel because of my busy work and I wanted to sync through IRC meetings... I saw the link previously but I have not notice that there have been a bunch of updates on the Etherpad16:24
*** JoseMello has joined #openstack-doc16:29
ianychoisetuid, actually my honest idea for this needs to be discussed through wider view of OpenStack. I am now contributing mainly in I18n team, happy to contribute in Docs team as an individual contributor and hope that such wider topics will be driven by other contributors.16:37
*** donghao has joined #openstack-doc16:41
*** annegentle has quit IRC16:42
*** efoley has quit IRC16:49
openstackgerritMerged openstack/security-doc master: Fix link to Swift API  https://review.openstack.org/49017716:51
*** pcaruana has quit IRC16:54
*** tosky has quit IRC17:01
*** rcernin has joined #openstack-doc17:02
*** khushbu has joined #openstack-doc17:24
*** donghao has quit IRC17:24
*** jpena is now known as jpena|off17:25
*** ekcs has joined #openstack-doc17:44
*** ujuc has quit IRC17:49
*** tesseract has quit IRC17:49
*** gouthamr has joined #openstack-doc17:53
*** annegentle has joined #openstack-doc17:58
*** sekelso has joined #openstack-doc18:03
*** skelso has quit IRC18:04
*** rabel has quit IRC18:30
*** khushbu has quit IRC18:32
*** ujuc has joined #openstack-doc18:47
*** ujuc has quit IRC18:51
*** sekelso has quit IRC19:19
*** sekelso has joined #openstack-doc19:20
*** skelso has joined #openstack-doc19:29
*** sekelso has quit IRC19:31
*** annegentle has quit IRC19:57
*** annegentle has joined #openstack-doc20:01
*** mriedem has quit IRC20:25
*** ujuc has joined #openstack-doc20:35
*** ujuc has quit IRC20:40
*** mriedem has joined #openstack-doc20:44
*** ujuc has joined #openstack-doc20:50
*** ujuc has quit IRC20:54
*** skelso has quit IRC20:56
*** skelso has joined #openstack-doc21:05
*** thorst_afk has quit IRC21:10
*** thorst_afk has joined #openstack-doc21:12
*** skelso has quit IRC21:16
*** skelso has joined #openstack-doc21:17
*** thorst_afk has quit IRC21:17
*** efoley has joined #openstack-doc21:20
*** yamamoto has joined #openstack-doc21:21
*** yamamoto has quit IRC21:26
*** thorst_afk has joined #openstack-doc21:30
*** thorst_afk has quit IRC21:34
*** annegentle has quit IRC21:45
*** thorst_afk has joined #openstack-doc21:50
*** thorst_afk has quit IRC21:55
*** yamamoto has joined #openstack-doc21:58
*** ekcs has quit IRC22:03
*** ekcs has joined #openstack-doc22:04
*** mihalis68 has quit IRC22:09
*** annegentle has joined #openstack-doc22:09
*** annegentle has quit IRC22:15
*** dustins has quit IRC22:21
*** edmondsw has quit IRC22:23
*** ekcs has quit IRC22:24
*** JoseMello has quit IRC22:26
*** edmondsw has joined #openstack-doc22:26
*** ekcs has joined #openstack-doc22:27
*** skelso has quit IRC22:28
*** edmondsw has quit IRC22:31
*** ujuc has joined #openstack-doc22:38
*** ujuc has quit IRC22:43
*** suyog has joined #openstack-doc22:52
*** sdague has quit IRC22:56
*** rcernin has quit IRC22:58
*** mriedem1 has joined #openstack-doc23:23
*** mriedem has quit IRC23:25
*** thorst_afk has joined #openstack-doc23:26
*** thorst_afk has quit IRC23:32
*** edmondsw has joined #openstack-doc23:54
*** rbowen has quit IRC23:54
*** edmondsw has quit IRC23:58

Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!