Falcon LogScale Documentation

List item A

List item B

List item C

For simple term references within text, for example to call out an element or term we use simple highlighting

For code markup, when referencing a code fragment, or search fragment we use a code markup style

Class names, for example when referring to underlying parts of the Humio code, are style like Classname

Parameters within configurations are styled parameter.

User input, for example a command within output is style like this, while replaceable items, for example when referring to a filename are style like this, you can see an example:

shell> tar zxf zookeeper.tar.gz

Filenames, directories and paths are marked up using /path/to/filename

For keyboard combinations A or Ctrl+A

References to UI components, including This is guilabel

Function names and class names within the product are styled function()

Variables, within Humio and the environment, are styled VARIABLE_NAME

Arguments to functions: argument

Buttons within the UI: Click Here

Menus in the output have the Menu style, while an individual Item is identified separately.

Variable names, for example when configuring Humio will use the Variable_name style.

Commands used in the shell, for example java or humioctl

We sometimes call out Terms or Functionality Names

Errors are called with a specific Error Message and we'll call out the message explicitly within the documentation. A corresponding Errorname and errortype may also be used.