Details
-
Task
-
Resolution: Obsolete
-
Minor
-
None
-
1.0.0.Beta on RHEL
-
Documentation (Ref Guide, User Guide, etc.)
Description
Make the same changes as ENTMQST-500 in the Streams on RHEL documentation.
Check if there is any more to change in OCP documentation
===================
jtyrrell and scholzj recommend we replace <my-topic> type things with topic-name in italics with no brackets so I can copy and paste it and it works. Use italics for the visual, but no brackets since they break things.
"less you have to type the better it is - the less that can go wrong - so instead of <replaceable> have it be a term that works when you copy - italics wihtout brackets gives you a visual and it works right from the copy/paste"
-----------
Tom Bentley:
There are subtle differences between the docs in the on-RHEL and on-OCP repos. For example in the one we've taken out the `<` and `>` for replaceables, but in the other. Another difference is that the replaceable tokens are `CamelCase` in the RHEL docs and `using-dashes` for strimzi.
We should try to make these consistent as it makes it easier to write docs if you're not having to switch between the two styles. It also makes it easier to just copy docs on the occasions when that's necessary.