Andrey Zagrebin created FLINK-18309:
---------------------------------------
Summary: Recommend avoiding uppercase to emphasise statements in
doc style
Key: FLINK-18309
URL: https://issues.apache.org/jira/browse/FLINK-18309
Project: Flink
Issue Type: Improvement
Components: Project Website
Reporter: Andrey Zagrebin
Assignee: Andrey Zagrebin
Some contributions tend to use uppercase in user docs to highlight and/or
emphasise statements. For example: "you MUST use the latest version". This
style may appear somewhat aggressive to users.
Therefore, I suggest to add a recommendation to not use uppercase in user docs.
We could highlight this statements as note paragraphs or with less 'shooting'
style, e.g. italics to draw user attention.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
