Conventions

This section explains several conventions used in this documentation. Heavily influenced by the conventions used in mkdocs-material 🙏.

Symbols

– Version

The tag symbol in conjunction with a version number denotes when a specific feature or behavior was added. Make sure you're at least on this version if you want to use it.

– Default value

Some properties can have a default value, which is used if you don't specify it explicitly.

– Property type

Every property has a type, which is usually one of the following:

• string – an arbitrary - string - value
• boolean – a boolean value, which can be true or false
• number – a numeric value
• list – a list of values
• enum - an enumerated value, which can be one of the predefined values

– Experimental

Some newer features are still considered experimental, which means they might (although rarely) change at any time, or might be considered not so stable yet.

– Required

Some properties can be required, which means you must specify them in your configuration file.

– Required if

Some properties can be required only if a certain condition is met, for example, if another feature is enabled. You'll find the condition next to the symbol.

– Configuration

This symbol indicates that a dedicated configuration section is available for the feature or integration you are reading about.