Was this page helpful?
You're viewing documentation for an unstable version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
At ScyllaDB, we limit the admonitions. Although restructuredText will allow for more, use the following:
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
text follows here
Use caution if there is any potential risk to data loss or lower performance.
.. caution:: look out 1. Step a 2. Step b
Use warning if there is any potential risk to total data loss or physical danger.
.. warning:: take care
This is a time-saving or performance enhancing option.
.. tip:: here's a tip
here’s a tip