| *** jamesmcarthur has joined #openstack-doc | 00:26 | |
| *** brinzhang has quit IRC | 00:33 | |
| *** brinzhang has joined #openstack-doc | 00:33 | |
| *** brinzhang_ has joined #openstack-doc | 00:36 | |
| *** brinzhang has quit IRC | 00:39 | |
| *** jamesmcarthur has quit IRC | 01:37 | |
| *** jamesmcarthur has joined #openstack-doc | 02:05 | |
| *** jamesmcarthur has quit IRC | 02:20 | |
| *** pcaruana has joined #openstack-doc | 06:18 | |
| *** brinzhang has joined #openstack-doc | 07:03 | |
| *** brinzhang_ has quit IRC | 07:06 | |
| *** AJaeger has quit IRC | 07:48 | |
| *** tesseract has joined #openstack-doc | 07:59 | |
| *** brinzhang_ has joined #openstack-doc | 08:05 | |
| *** AJaeger has joined #openstack-doc | 08:06 | |
| *** brinzhang has quit IRC | 08:07 | |
| *** tosky has joined #openstack-doc | 08:27 | |
| *** tonyb has quit IRC | 08:56 | |
| *** tonyb has joined #openstack-doc | 08:56 | |
| *** goldyfruit_ has quit IRC | 09:29 | |
| *** alexmcleod has joined #openstack-doc | 10:32 | |
| *** goldyfruit_ has joined #openstack-doc | 10:50 | |
| *** rcernin has quit IRC | 10:56 | |
| *** pcaruana has quit IRC | 11:03 | |
| *** pcaruana has joined #openstack-doc | 11:06 | |
| *** goldyfruit_ has quit IRC | 11:13 | |
| *** dmacpher has quit IRC | 13:01 | |
| *** dmacpher has joined #openstack-doc | 13:02 | |
| *** jamesmcarthur has joined #openstack-doc | 13:20 | |
| *** jamesmcarthur has quit IRC | 13:36 | |
| *** jamesmcarthur has joined #openstack-doc | 13:37 | |
| *** jamesmcarthur has quit IRC | 13:45 | |
| *** jamesmcarthur has joined #openstack-doc | 13:47 | |
| *** dmacpher has quit IRC | 13:56 | |
| *** pcaruana has quit IRC | 13:57 | |
| *** dmacpher has joined #openstack-doc | 14:34 | |
| *** jamesmcarthur has quit IRC | 14:35 | |
| *** jamesmcarthur has joined #openstack-doc | 14:35 | |
| *** pcaruana has joined #openstack-doc | 14:36 | |
| *** jamesmcarthur has quit IRC | 14:37 | |
| *** jamesmcarthur_ has joined #openstack-doc | 14:37 | |
| *** gudrutis2 has joined #openstack-doc | 14:59 | |
| *** lbragstad has joined #openstack-doc | 15:04 | |
| *** KeithMnemonic has joined #openstack-doc | 15:07 | |
| *** jamesmcarthur_ has quit IRC | 15:15 | |
| *** jamesmcarthur has joined #openstack-doc | 15:16 | |
| *** jamesmcarthur has quit IRC | 15:22 | |
| *** jamesmcarthur has joined #openstack-doc | 15:23 | |
| *** jamesmcarthur has quit IRC | 15:31 | |
| *** jamesmcarthur has joined #openstack-doc | 15:31 | |
| *** jamesmcarthur has quit IRC | 15:34 | |
| *** jamesmcarthur has joined #openstack-doc | 15:34 | |
| gudrutis2 | Hi Docs people o\-< . I am a new person mainly working with Ironic project. Nice meeting you all :) Now at #openstack-ironic we had some thoughts and suggestions about documentation: | 15:36 |
|---|---|---|
| gudrutis2 | 1) We would like to port https://wiki.openstack.org/wiki/Testing to the new page, any suggestions for suitable place? | 15:37 |
| gudrutis2 | 2) As I understand http://wiki.openstack.org/Documentation/HowT | 15:38 |
| gudrutis2 | sorry, | 15:38 |
| gudrutis2 | 2) As I understand, http://wiki.openstack.org/ is old and http://docs.openstack.org/ is prefered page. Maybe we should put a banner in the main page of wiki saying that? | 15:40 |
| AJaeger | gudrutis2: the docs team is not in charge of the wiki, we cannot help you with a banner | 15:48 |
| AJaeger | gudrutis2: if you want to publish to docs.o.o, add documentation to your openstack repos doc/source folder and | 15:48 |
| AJaeger | publish it ;) | 15:49 |
| gudrutis2 | AJaeger: the documentation is for developers in general, not service related | 15:50 |
| gudrutis2 | for example, since I am new, today I learned handy way to debug unit tests. `source .tox/py36/bin/activate ; stestr run -n ironic_inspector.test.unit.test_rules.TestApplyActions.test_apply` | 15:51 |
| AJaeger | https://docs.openstack.org/project-team-guide/ might be appropriate then | 15:51 |
| *** pmatulis has left #openstack-doc | 15:54 | |
| *** jamesmcarthur has quit IRC | 16:09 | |
| *** jamesmcarthur has joined #openstack-doc | 16:10 | |
| *** irclogbot_2 has quit IRC | 16:14 | |
| *** irclogbot_2 has joined #openstack-doc | 16:15 | |
| *** jamesmcarthur has quit IRC | 16:15 | |
| *** jamesmcarthur has joined #openstack-doc | 16:16 | |
| *** lbragstad has quit IRC | 16:16 | |
| *** pmatulis has joined #openstack-doc | 16:17 | |
| pmatulis | is there a way to change the colours created with | 16:17 |
| pmatulis | .. code-block:: console | 16:18 |
| pmatulis | :emphasize-lines: 1-3 | 16:18 |
| pmatulis | white on grey isn't the best default | 16:18 |
| *** lbragstad has joined #openstack-doc | 16:35 | |
| *** jamesmcarthur has quit IRC | 16:42 | |
| *** jamesmcarthur has joined #openstack-doc | 16:43 | |
| *** jamesmcarthur_ has joined #openstack-doc | 16:47 | |
| *** tesseract has quit IRC | 16:48 | |
| *** jamesmcarthur has quit IRC | 16:51 | |
| *** alexmcleod has quit IRC | 16:56 | |
| *** jamesmcarthur_ has quit IRC | 17:06 | |
| efried | pmatulis: certainly via the theme | 17:06 |
| efried | pmatulis: If the theme default is unreadable, it should be changed. | 17:07 |
| *** efried is now known as efried_afk | 17:08 | |
| *** jamesmcarthur has joined #openstack-doc | 17:32 | |
| * pmatulis makes a note | 17:33 | |
| pmatulis | something else now. how do i get the "expander buttons" as seen on this page: | 17:34 |
| pmatulis | https://docs.openstack.org/api-ref/compute | 17:34 |
| *** dmacpher_ has joined #openstack-doc | 17:35 | |
| *** KeithMnemonic has quit IRC | 17:36 | |
| *** dmacpher has quit IRC | 17:38 | |
| *** dmacpher_ has quit IRC | 17:50 | |
| *** lbragstad has quit IRC | 17:52 | |
| *** jamesmcarthur has quit IRC | 18:04 | |
| *** jamesmcarthur has joined #openstack-doc | 18:04 | |
| *** jamesmcarthur has quit IRC | 18:07 | |
| *** jamesmcarthur has joined #openstack-doc | 18:07 | |
| *** jamesmcarthur has quit IRC | 18:22 | |
| *** gmann is now known as gmann_afk | 18:53 | |
| *** tosky has quit IRC | 19:21 | |
| *** efried_afk is now known as efried | 19:38 | |
| *** KeithMnemonic has joined #openstack-doc | 20:09 | |
| *** pcaruana has quit IRC | 20:19 | |
| efried | pmatulis: I would have to go figure that out; but the source is in the nova project under api-ref/source | 21:01 |
| efried | looking at the conf.py in there, I'm going to take a first wild guess that it's via the "os_api_ref" extension. | 21:02 |
| *** EmilienM is now known as EmilienM|mtg | 21:10 | |
| efried | pmatulis: Yeah, it looks to me like all of that happens by magic. | 21:10 |
| efried | The index.rst just includes all of the .inc files. | 21:10 |
| efried | The .inc files use directives like rest_method and rest_parameters, which I assume come from that os_api_ref extension. | 21:10 |
| efried | doc/requirements.txt lists | 21:11 |
| efried | os-api-ref>=1.4.0 # Apache-2.0 | 21:11 |
| efried | ...along with the usual sphinx-y stuff. | 21:11 |
| efried | and openstackdocstheme | 21:11 |
| efried | and tox.ini just shows the api-ref target building using the env & deps from the docs target, and using a normal-looking sphinx-build command. | 21:12 |
| efried | pmatulis: I gotta ask, what are you building? | 21:13 |
| efried | api-ref for a brand new service? | 21:13 |
| *** EmilienM|mtg is now known as EmilienM | 21:15 | |
| pmatulis | efried, we *are* talking about the buttons that toggle details/close ya? | 21:16 |
| pmatulis | and i'm assuming they can be used with any content? | 21:17 |
| efried | pmatulis: Given the results of my sleuthing above, I'm 96.8% sure those buttons are being generated by os-api-ref. Using os-api-ref for docs that aren't api-ref seems like it would be kind of odd. | 21:18 |
| efried | BUT it's also possible that the buttons are part of openstackdocstheme and os-api-ref is just a wrapper bundling that and other pieces into convenient one-stop directives for rest_method/rest_parameters | 21:19 |
| efried | stephenfin might know that answer off the top, but he's (hopefully) afk until morning UTC. | 21:20 |
| pmatulis | it would be nice to be able to hide extra non-essential content. like command output and so on | 21:20 |
| pmatulis | (long command output) | 21:21 |
| efried | well... | 21:22 |
| * efried clones os-api-ref... | 21:22 | |
| efried | so, the HTML for the button is hardcoded. | 21:25 |
| efried | ...and the CSS and JS is in that same project. So yeah, it's all in os-api-ref. | 21:27 |
| efried | pmatulis: So in short: no you can't use the expandybutton without using (or duplicating) os-api-ref. | 21:30 |
| pmatulis | darn | 21:30 |
| efried | And if you wanted to piggyback on os-api-ref, you would have to find a way to shoehorn your content into the rest_method directive... | 21:30 |
| efried | ...which could wind up being pretty weird. | 21:30 |
| pmatulis | efried, thanks for looking it up | 21:32 |
| efried | Basically, | 21:32 |
| efried | $title | 21:32 |
| efried | ====== | 21:32 |
| efried | .. rest_method:: $verb $path | 21:32 |
| efried | will render with the $verb in a colored box (ahem, I didn't check, but it might actually fail if it's not one of the standard HTTP verbs), followed by $path, followed by the detail button | 21:32 |
| efried | and then on the next line, the $title in bold | 21:32 |
| efried | and | 21:32 |
| efried | if they decide to change the theme at some point | 21:32 |
| efried | like, make it "HTTP $verb" | 21:33 |
| efried | you'd be carried along and probably not happy about it. | 21:33 |
| efried | pmatulis: now, I suspect if you wanted to port a genericized version of that `detail` button to openstackdocstheme, you could get support from the maintainers. | 21:34 |
| efried | .. expandybutton:: header/title goes here | 21:36 |
| efried | :labelClosed: + | 21:36 |
| efried | :labelOpen: - | 21:36 |
| efried | content goes here in an indented paragraph | 21:36 |
| efried | regarding the REST $verb, it looks like this: | 21:44 |
| efried | <span class="label label-%(method)s">%(method)s</span> | 21:44 |
| efried | where those label-%(method)s are hardcoded CSS classes (like label-POST). I don't know/remember what happens to your rendered page if you ref a CSS class that doesn't exist. Guessing you get the default font etc. | 21:44 |
| efried | So, again not saying you should, but if you were piggybacking, you might be able to get away with: | 21:46 |
| efried | .. rest_method:: fig_1 Example | 21:46 |
| efried | not sure how tolerant the directive would be of multiple tokens there... | 21:46 |
| pmatulis | i appreciate your time here but i don't want to get into trouble later on. i try to avoid rabbit holes when my plate is full | 21:47 |
| pmatulis | maybe i can just open a bug for now | 21:47 |
| efried | an RFE | 21:47 |
| efried | I suspect openstackdocstheme is storyboard, so it's all the same :) | 21:48 |
| pmatulis | an RFE is using a different tracker? | 21:48 |
| efried | no, it would be a story with a 'rfe' tag rather than a 'bug' tag. | 21:48 |
| efried | In launchpad it would be a bug with a 'rfe' tag too. | 21:48 |
| efried | I just don't like calling feature requests "bugs". | 21:48 |
| efried | personal thing. | 21:49 |
| efried | I want to say I was in this space (opening a tracked thingy in/near openstackdocstheme) recently and it was weird/non-obvious where they went. | 21:49 |
| efried | AJaeger: where do openstackdocstheme RFEs go these days? | 21:49 |
| efried | (Andreas might not respond until tomorrow or 2020. I think he's EU, and not sure what vacation plans etc.) | 21:50 |
| pmatulis | i wonder what the seers and astrologers are saying about "twenty-twenty". must be awesome | 21:58 |
| *** aluria has quit IRC | 22:02 | |
| efried | oh, there will be all kinds of "hindsight" puns etc. | 22:24 |
| *** gmann_afk is now known as gmann | 22:29 | |
| efried | pmatulis: I started this https://review.opendev.org/698814 | 23:04 |
| efried | I'm probably not going to keep working on it, so if you want to pick it up, feel free. | 23:04 |
| efried | I started by pretty much copying the stuff from os-api-ref. | 23:05 |
| efried | I added a test for it in api-ref/source/test_expand.rst | 23:06 |
| efried | It builds (tox -e api-ref) but doesn't work yet. | 23:06 |
| efried | ("Ou en français si vous preferez" --Braveheart) | 23:07 |
| efried | ("Il ne marche pas encore") | 23:07 |
| *** irclogbot_2 has quit IRC | 23:11 | |
| *** irclogbot_1 has joined #openstack-doc | 23:11 | |
Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!