Admonitions¶

At ScyllaDB, we limit the admonitions. Although restructuredText will allow for more, use the following:

• Note

• Caution

• Warning

• Tip

Note¶

Use a note to point out something to the reader. This action does not have any risk.

.. note::

   text follows here

   * Option a
   * Option b

Renders as:

Note

text follows here

• Option a

• Option b

Caution¶

Use caution if there is any potential risk to data loss or lower performance.

.. caution::

   look out

   1. Step a
   2. Step b

Renders as

Caution

look out

1. Step a

2. Step b

Warning¶

Use warning if there is any potential risk to total data loss or physical danger.

.. warning:: take care

Renders as:

Warning

take care

Tip¶

This is a time-saving or performance enhancing option.

.. tip:: here's a tip

Renders as:

Tip

here’s a tip