search

redhat-documentation / asciidoc-markup-conventions

How to use AsciiDoc mark-up to properly style elements in Red Hat documentation
https://access.redhat.com/documentation/
17 stars 16 forks source link

nbsp for product names #24

Closed mishaone closed 6 years ago

mishaone commented 6 years ago

The company name and product name guidelines indicate no special markup, but we should have a non-breaking space markup recommended. I believe the guidelines in the past were something like this:

Red Hat Enterprise Linux

rkratky commented 6 years ago

@mishaone, good point. I don't see the mark-up you used for RHEL above, but I suspect it's this, right?

Red{nbsp}Hat Enterprise{nbsp}Linux

Trouble is that there are so many products, it would be impractical to list them all in this doc. Can we get by with a general recommendation?

mishaone commented 6 years ago

Absolutely, Robert. I think one example to illustrate it is fine and then people can apply as relevant to thier own products. As long as things like Red and Hat being on different lines or the product name doing the same is avoided, we should be fine.

rkratky commented 6 years ago

Could you please submit a PR to that effect?

mishaone commented 6 years ago

Done, needs review+merge: https://github.com/redhat-documentation/asciidoc-markup-conventions/pull/26