[FLINK-20900] Extend documentation guidelines to cover formatting of commands

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Component/s: Documentation
• Labels: pull-request-available
• Assignee: Matthias Pohl
• Reporter: Matthias Pohl
• Created: 08/Jan/21 12:26
• Updated: 13/Jan/21 07:37
• Resolved: 13/Jan/21 07:37

Description

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 `$`

Issue Links

• links to: GitHub Pull Request #411