Skip to content

Latest commit

 

History

History
16 lines (10 loc) · 867 Bytes

CONTRIBUTING.md

File metadata and controls

16 lines (10 loc) · 867 Bytes
Raw

Syntactic and Stylistic Guidelines

Syntax

All text content should adhere to the guidelines provided by official Markdown Guide:

Styling

  • Always highlight paths and file names as bold, e.g. /etc/hosts or package.json
  • Always highlight UI choices/navigation etc as italic, e.g. "[...] then click Create ECS Server on Open Telekom Cloud Console."
  • Variables and their values should be always highlight as inline code, e.g. "[...] change the replica count to 1"
  • If you provide a code-block that requires a specific file name for the blueprint to work, insert always the file name in the header of the code-block, e.g. "yaml title="credentials.yaml [...] "