#6561 - Better looking puppetdoc CSS for rdoc mode

[masterzen]

This is an old patch that never got merged during 2.7 merge window:
https://projects.puppetlabs.com/issues/6561

I'm resurrecting (rebased) the changeset in the hope it will get merged, as it enhances the look of the puppet doc rdoc output.

Thanks!

[puppetcla]

CLA Signed by masterzen on 2010-08-14 21:00:00 -0700

[zaphod42]

@nfagerlund can you take a look at this?

[nfagerlund]

@zaphod42 This isn't really my bailiwick. I have no special insight into these CSS changes, and can't identify all the repercussions of editing it. I assume they're fine?

Surely you'd do better to get one of the web front-end engineers to take a look at it? Or maybe @RColeman since this is relevant to module authors and consumers.

Also, keep in mind that puppet doc rdoc mode remains busted for all 1.9 and 2.0 users.

[adrienthebo]

@melinda-campbell you're a front end engineer, could you and @hunner or @apenney look this over?

[masterzen]

As soon as I get a couple of spare seconds, I'll upload a sample of the output with the previous CSS and the new CSS so that you can judge if that's better or not (I do think it's better).

Note that the scope of this is very limited as it only changes the puppet doc CSS when used in rdoc mode, as such it is pretty safe, IMHO.

[ryanycoleman]

@melinda-campbell If you've got spare time this week, I think this is worth the time and I'm happy to help you get an environment going to test the change.

[masterzen]

If you want to get a before/after picture, point your browser to:

Before this patch

After this patch

[ryanycoleman]

@masterzen thanks for the two sites! It was really handy and the css changes are subtle but a nice improvement.

@nfagerlund I'm +1 to this though I admit that I've only played with the sites linked above, I haven't run this against other scenarios. It seems like a pretty harmless change, but I'm looking to you for the final 👍

[nfagerlund]

@RColeman This is a web design question, not a documentation question. I do not do web design. This issue should not be assigned to the docs team, and I should not be making the final decision.

It looks fine to me, it's better than the old CSS, I don't really have a strong opinion on it. The text is too small, but once you hit cmd-plus a few times it looks fine. Maybe bump the main font size bigger than 12px.

[ryanycoleman]

@nfagerlund fine, consider yourself off the hook. I'll add this into the next Forge team sprint (starting Friday) and achieve a resolution that way.

[nfagerlund]

Awesome, thank you @RColeman.

[adrienthebo]

I agree with #1729 (comment) regarding the font size. I must be getting old and going blind, because the original font size seemed a bit easier to read. That aside I'm 👍; @masterzen thanks for submitting this PR and the CSS demos!

[masterzen]

I can probably increase the font size a bit. I'll see what I can do (I'm not myself very good with CSS...)

[masterzen]

I pushed a commit to this PR that increases the font size a bit to ease reading. I also fixed the way facts attributes were displayed.
You can check the result (provided you flush your browser cache to make sure the css is reloaded) at the previous links I posted.

[adrienthebo]

I'm ready to merge this but right now the build is failing. As soon as the build is passing I'll merge this. Thanks for the contribution!

[ryanycoleman]

On Wed, Jul 10, 2013 at 11:45 AM, Adrien Thebo [email protected]:

I'm ready to merge this but right now the build is failing. As soon as the
build is passing I'll merge this. Thanks for the contribution!

Yeah, +1. These changes are nice, thanks Brice!

[adrienthebo]

summary: merged into master in 8b3b90a; this should be released in 3.3.0. Thanks again for the contribution!