Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 608 Bytes

code-formatting.adoc

File metadata and controls

15 lines (12 loc) · 608 Bytes

Redpanda Data Documentation Code Formatting Guidelines

Commands and code

Don’t start a sentence with a command or code. Instead, try to move the code into the middle of the sentence. Introduce the command with the more descriptive word “run” instead of “use the X command".

+ Correct: Run the rpk topic create command to create a new topic.

+ Incorrect: rpk topic create creates a new topic.

Similarly, do not start a sentence with a filename.

+ Correct: The redpanda.yaml file contains configuration parameters.

+ Incorrect: redpanda.yaml contains configuration parameters.