Follow Formatting Standards
Only use the original capitalization found in the code or configuration files when referencing those values directly. Use back-ticks `` around the referenced value to make the connection explicit. For example, use IstioRoleBinding
, not Istio Role Binding
or istio role binding
.
Use angle brackets for placeholders
Use angle brackets for placeholders in commands or code samples. Tell the reader what the placeholder represents. For example:
Use italics to emphasize new terms
Use back-ticks
around inline code and commands
Use code-blocks for commands you intend readers to execute. Only use inline code and commands to mention specific labels, flags, values, functions, objects, variables, modules, or commands.