`, to avoid such problems 15:12:36 all right, more tweaking and testing today . . . thanks for the pointers! 15:13:36 can't we render that directly in the RST ? 15:14:09 there may be other ways to do the banner. I just found an example and modified it to fit our needs 15:14:17 baptistemm: parts of it yes (probably the things dependent on the relative path). the things depending on the domain, probably not 15:14:47 baptistemm: it's not completely obvious though how to get hold of the filename of the currently templated file, at least from the docs I found (haven't tried it) 15:15:23 though the build would need external input probably 15:15:35 anyway, the current solution works good enough without changing the build :) 15:16:03 speaking of docsite stuff, we turned the broken `Edit on GitHub` links off for the module/plugin docs for now, until we have a way to route those: https://github.com/ansible/ansible/pull/70951 (thanks samccann!) 15:16:49 When I am dealing with the sphinx, I usually parameterize the documentation generation. This means that I neeed to generate docs for each combination of domains/parameters, but I found it way more maintainable compared to messing around with the javascript. 15:17:04 Yeah it's a temporary fix so I didn't close all the existing 'edit on github is broken' issues. So we remember that needs some coding magic to bring it back. 15:17:13 tadeboro: can you post an example of the way you do that? 15:18:43 acozine: It will take me a while since I do not have access to my office computer that contains those files (company is renovating the offices and cutting cables if fun or something). 15:19:01 tadeboro: ah, renovations! 15:19:18 acozine: But will do it ASAP. But things boil down to setting a few html_theme_options in the config and then using them in the templates. 15:19:27 if/when you get a chance, it would be great to see that code 15:20:03 the same for me 15:20:05 #action - tadeboro to provide sphinx example for parameterized doc generation (when time permits) 15:20:23 not pressure ^^ just want it as a reminder so we can ask again in a couple of weeks 15:20:51 thanks samccann for keeping us organized! 15:21:32 any other ideas/suggestions/complaints/comments on the docsite formatting/look-and-feel/banners? 15:21:58 acozine: as I said I con't link the content on the left banner 15:22:11 s/con/don/ 15:22:29 but this is a huge task to tackle 15:22:30 yeah, I'm sure there's a way to make that link work 15:22:40 I just don't know what it is yet 15:23:21 acozine: is there an improvement to use the sphinx theme that is hosted on separatated repo ? 15:23:32 * baptistemm stumbled 15:23:52 the improvement would be when we make something work, it will work for anyone using that theme 15:24:13 But the drawback is - we'd have to test the improvements out on ...anyone using that theme :-) 15:25:10 and we'd probably have to have someone in RH officially 'maintain' that theme since our docs would depend on it. 15:25:32 ultimately it would be good to use the "packaged" theme, but it might solve some problems and introduce different/new problems 15:26:15 is it possible to extend / inherit themes? 15:26:16 if we could come up with some way to test the theme regularly, that would be awesome 15:26:28 samccann: I don't think we're building docs for things shipped in rht anymore. 15:26:30 so like most things can be moved to a common base theme, and things like the banners could be ansible-only? 15:26:37 felixfontein: I'm not sure, I assume you can override certain files locally 15:26:43 so it's probably okay if it's maintained outside of rht. 15:26:57 abadger1999: welcome~ 15:27:01 #chair abadger1999 15:27:01 Current chairs: abadger1999 acozine baptistemm cbudz felixfontein gundalow samccann tadeboro 15:27:04 (as long as everyone gets along well ;-) 15:27:12 Sphinx themes can be extended, but it is not as easy as one would have hoped. 15:27:26 tadeboro: that sounds like the voice of experience 15:27:41 abadger1999: not sure about that. if docs.ansible.com depends on this reusable theme, we'd have to 'adopt' it wouldn't we? Otherwise community could decide to change the color to purple or something and we'd have no notice 15:27:51 I don't know how RH patch the docsite for the redhat automation hub 15:28:18 baptistemm: that's entirely handled by RH internally. 15:28:39 baptistemm: the AH docs don't use sphinx 15:28:44 samccann: Maybe? It's similar to what would happen if sphinx or the notfound plugin updated incompatibly, though. 15:28:56 abadger1999: true 15:28:57 So I suppose it's degree of risk. 15:29:09 does AH also contain ansible docs? (I mean the ansible docs from ansible/ansible) 15:29:18 yeah I guess we do just grab these things and hope for the best over time! 15:29:27 felixfontein: no, only module/plugin docs 15:29:29 felixfontein: AS far as I can tell no. 15:30:04 ok 15:30:15 #info - the reusable sphinx theme would be good to adopt, but we need to figure out a way to test changes so it won't break all the places currently using it 15:30:44 samccann: can't we render pages produced during PR to a temporary place ? 15:30:57 it's the end of our scheduled hour . . . can folks stick around for ten more minutes? 15:31:03 I seems other RH docs team for openshift doing that 15:31:05 sure 15:31:09 we can yes... I don't know what ansible-lint can do for example. it's hosted somewhere else 15:31:20 baptistemm: yes, we can publish any branch to the testing site 15:31:41 any of OUR branches. not the stuff up on readthedocs using this reusabl theme 15:31:49 true 15:32:12 but something like http://pr-34353.testing.ansible.com/ would be awesome 15:32:46 baptistemm: huh, interesting idea, that would be cool 15:33:06 should be protected by HTTP basic auth though, IMO, to avoid this being abused to host random stuff 15:33:08 not sure how to acheive to that 15:33:12 felixfontein: indeed 15:33:31 agreed 15:34:07 (I'm wondering whether someone already abused a project's CI to mine bitcoin/...?) 15:34:23 heh, probably 15:34:41 felixfontein: ah you thought about someone adding some JS in the PR 15:34:57 you're too smart to me 15:34:58 I don't think we'd want to make that fully automated 15:35:24 baptistemm: in case of docs PR, more like some binary file (say with malware) 15:35:36 or a phishing form 15:35:39 among other things, we'd quickly have hundreds of sets of the docs on the testing site 15:36:08 even if no abuse happened (which it probably would) 15:36:22 yep 15:37:06 #info explore options for publishing individual PR changes to the test site in a way that makes them easy to find, for example `PR2.testing.ansible.com` or similar, with security and cleanup 15:37:14 We at my company generate docs on MRs that have a specific tag + master branch. 15:37:37 (We use Gitlab internaly, this is why MRs and not PRs ;) 15:38:02 tadeboro: generate the docs to URLs that include the tag? 15:39:16 I think we need to focus on the challenges of the 2.10 docs first, though 15:39:29 :-) 15:39:52 once 2.10 has been released, this stuff would be great to explore! 15:40:00 in that spirit . . . 15:40:06 #topic docs pipeline update 15:40:13 abadger1999: could you do a quick update on pipeline issues? 15:41:15 Over the past week, I fixed a couple bugs that were causing the pipeline to fail on specific user's platforms. 15:41:48 hooray! 15:42:02 (macos was having trouble building the devel docs; my system was having trouble with virtulenvs for some reason) 15:42:22 I started work on routing but it didn't get my full attention like I thought. 15:42:34 I have an outline of how to do it and the dependencies needed. 15:42:47 But only a skeleton of code so far. 15:43:32 any blockers we can help with? 15:43:35 I haven't encountered anything that I would consider a blocker, though. 15:43:56 cool 15:44:25 It's mostly just a matter of writing code but I suppose there are some questions about how the redirects should be output. 15:44:50 (Each directory has its own .httpaccess file? One central file for all redirects?) 15:45:00 Those may be better to look at once I have a strawman, though. 15:45:24 sounds good 15:45:41 Implement it using one central file and then you all can tell me if it should be done differently ;-) 15:45:53 heh 15:46:04 probably it's best to collect all redirects and have some global redirect writer - that could then be easily changed to output them differently (or even for another HTTP server) 15:46:27 Since this is likely to need to be run repeatedly, I think it will end up being a new script in the antsibull package. 15:47:35 I was thinking of just doing a one-off script a few weeks ago, but I think there's likely to be updates to the ansible-base runtime.yml into the future (or at least pressure to update it and I want to be prepared whichever way that decision ends up falling). 15:47:53 that sounds like smart future-proofing 15:48:16 That's all I have for status for this week :-) 15:48:21 ah, you are talking about these redirects, not the redirects inside collection docs 15:48:53 abadger1999: there *will* be updates: https://github.com/ansible/ansible/pull/71081 (probably won't make it into 2.10.0) 15:49:03 abadger1999: thanks! 15:49:28 felixfontein: Since I'm going to implement it inside of antsibull, I'll probably merge that functionality. 15:49:45 I'm not sure if it will be there immediately, though ;-) 15:49:50 :+1: 15:50:14 getting ansible-base's runtime.yml will hit 85% of the redirects so it's the big thing right now. 15:50:35 yep 15:50:59 and processing the others needs also new module/plugin listing code 15:51:03 (for antsibull-docs) 15:52:47 anything else on pipeline? 15:53:13 #topic open floor 15:53:40 all questions, complaints, suggestions, contributions welcome 15:54:32 chocolates also welcome :-) 15:54:36 as always, anyone can add an item to the official agenda by putting a comment on https://github.com/ansible/community/issues/521 15:54:41 samccann: ooh, chocolate 15:55:22 we prioritize agenda items from the community, and especially new contributors/participants 15:57:35 thanks abadger1999 baptistemm felixfontein samccann tadeboro gundalow cbudz 15:57:57 Thank you for running the meeting :-) 15:58:08 chat on the channel encouraged at all times, next official meeting next Tuesday, August 11 15:58:25 thanks a lot everyone! 15:58:30 #endmeeting