You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Andrey Zagrebin (Jira)" <ji...@apache.org> on 2020/06/16 16:29:00 UTC
[jira] [Closed] (FLINK-18309) Recommend avoiding uppercase to
emphasise statements in doc style
[ https://issues.apache.org/jira/browse/FLINK-18309?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Andrey Zagrebin closed FLINK-18309.
-----------------------------------
Resolution: Done
merged into asf-site by e6d47b6c0ab23cea0068ac6b710adff37e3cd934
> 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
> Priority: Major
> Labels: pull-request-available
>
> 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)