You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@flink.apache.org by "Matthias (Jira)" <ji...@apache.org> on 2021/01/08 12:27:00 UTC

[jira] [Created] (FLINK-20900) Extend documentation guidelines to cover formatting of commands

Matthias created FLINK-20900:
--------------------------------

             Summary: Extend documentation guidelines to cover formatting of commands
                 Key: FLINK-20900
                 URL: https://issues.apache.org/jira/browse/FLINK-20900
             Project: Flink
          Issue Type: Improvement
          Components: Documentation
            Reporter: Matthias


As part of refactoring the deployment documentation we came up with some agreements that we could add to the docs guidelines to get a more consistent look & feel:
* long parameter names for commands
* one parameter per line
* parameter line indented
* command preceded by `$`



--
This message was sent by Atlassian Jira
(v8.3.4#803005)