[openstack-dev] [ironic][docs] I see, you see, we all see red*

Loo, Ruby ruby.loo at intel.com
Tue Sep 19 17:52:29 UTC 2017


In case folks wonder what happened, I submitted a patch [1] to change it to black :)


[1] https://review.openstack.org/#/c/505348/

From: Ruby Loo <opensrloo at gmail.com>
Reply-To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org>
Date: Thursday, August 24, 2017 at 11:19 AM
To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org>
Subject: Re: [openstack-dev] [ironic][docs] I see, you see, we all see red*

Hi Alex,

Sorry, I don't know much about the docs stuff; Andreas' links were useful for enlightening me.

Clearly, I'm biased and would prefer no difference in colour. What about that (darker?) blue from [0], where it sez (I'm referring to the upper-cased words here) 'Modern color theory uses either the ... RED-CYAN, GREEN-MAGENTA, BLUE-YELLOW'. Would that blue clash with the blue you are mentioning? (Well, maybe it is the bold + blue that I like, not just the blue.)

I don't really think a complementary colour is good, orange is marginally better than red. I'd like it to be highlighted but I guess I like subtle, not strong.

Having said all that, I'm a reader/viewer of these documents and this is *just* my opinion. It seems to me that there might be research into what works best? Anyone know?


On Thu, Aug 24, 2017 at 6:19 AM, Alexandra Settle <a.settle at outlook.com<mailto:a.settle at outlook.com>> wrote:
Hey Ruby!

Good point – thanks for bringing it up :)

I was brought up to think that red was one of those colours that people had different (and sometimes really negative) associations with. When I look at our latest and greatest! ironic documentation (e.g. [1]), I see red. Not only do I see red, but the term has a different background colour and is bordered (or whatever it is called). Are we using the wrong .rst syntax, should we be highlighting terms differently? And/or is there some way to change the appearance of highlighted terms? I much prefer something simple, like bold black text in some uniform font. On the other hand, perhaps lots of others like this and I'm in the minority.

Andreas is right – the red definitely correct, and this is how we have always done it in manuals. But that doesn’t mean we have to continue. We just need to come up with another strong, inoffensive colour that matches; I believe the red was chosen to simply contrast the blue. A compromise, and complementary colour[0], would be orange. How would you feel about this?

I hesitated about sending this due to the wonderful bike shedding that could happen, don't disappoint me, cuz I'm sure we all have opinions about colour. :)

Not going to lie, also afraid of all the bike shedding! But you bring up a good point – and I don’t want others to also feel negatively about our documentation. We should be as inclusive as we can.

Also, this email thread isn't about discussing the green and orange colours used for the code blocks; feel free to start your own thread about that if you want!

No thanks, if I can avoid it :P



[0] https://en.wikipedia.org/wiki/Complementary_colors

OpenStack Development Mailing List (not for usage questions)
Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe<http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20170919/ed48d322/attachment.html>

More information about the OpenStack-dev mailing list