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

Posted to issues@flink.apache.org by "Robert Metzger (Jira)" <ji...@apache.org> on 2021/01/13 07:38:01 UTC

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

    [ https://issues.apache.org/jira/browse/FLINK-20900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17263957#comment-17263957 ] 

Robert Metzger commented on FLINK-20900:
----------------------------------------

Merged to flink-web in https://github.com/apache/flink-web/commit/38b3a48ca4ea40b2768f49e1c1df181c276b076e

> 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
>            Assignee: Matthias
>            Priority: Major
>              Labels: pull-request-available
>
> 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)