Skip to main content

Style Guide

Text Blocks​

Paragraphs must be written into one line. To correctly display the paragraph the word wrap feature of the code editor should be used.

Commands and source code must be wrapped into a code block.

Technical names like CLI command and directory names must be wrapped by backticks (`).

Example
example.md
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
example.md
The tool `kubectl` can be used to interact with the Kubernetes API.

Constants​

To ensure consistency in the naming a file with constant values has been added. These constants must be used for names like the company and the product name.

Example
example.md
Our {constants.productName} is the best product you can imagine.

Code Blocks​

Code blocks in the documentation

  • must be in a markdown code block
  • should have a reasonable file name as title
Example
example.md
```yaml title="secret.yaml"
apiVersion: v1
kind: Secret
metadata:
  name: dotfile-secret
data:
  .secret-file: dmFsdWUtMg0KDQo=
```