Documentation Conventions

Pulse documentation is intended to provide clarity and usefulness of information pertaining to the application functionality. This page contains conventions of fonts, code blocks, notes, and variables used across the Pulse documentation.

Fonts

FontMeaning
BoldIndicates names of elements visible in the UI.
ItalicsIndicates a variable that must be substituted with actual values. These variable are used in code phrases across the documentation.
Code PhraseIndicates a code phrase.
< >Indicates variables that are optional.
( )Indicates the measuring unit of a metric or can also indicate an optional step of an instruction.

Code blocks

Code blocks indicate a snippet of code used as an example or the actual code to be used.

Notes

Notes are represented in boxes as shown in the following image. They indicate information about instructions or functionality.

Note box

Variables

Variables indicate that those values can be substituted with actual values of your cluster environment.