From ce82e933b8e2e847e2112d4d50a953668daea8a5 Mon Sep 17 00:00:00 2001 From: Kseniia Antonova Date: Thu, 23 Sep 2021 18:47:15 +0300 Subject: [PATCH 1/4] Update admonitions --- doc/contributing/docs/markup/admonitions.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/contributing/docs/markup/admonitions.rst b/doc/contributing/docs/markup/admonitions.rst index 8fc6b75a0a..7253b935ae 100644 --- a/doc/contributing/docs/markup/admonitions.rst +++ b/doc/contributing/docs/markup/admonitions.rst @@ -34,6 +34,19 @@ In Tarantool we have 3 variants of css-style for admonitions: For example, in the description of :doc:`/reference/reference_lua/box_session/on_connect` trigger we warn a user about some consequences of his actions. +* Important: + + .. code-block:: rst + + .. IMPORTANT:: + + .. IMPORTANT:: + + This block contains essential information that the user should know while doing something. + + For example, the block :doc:`here ` is used to warn the user against + closing the terminal window. + * Custom admonition: .. code-block:: rst From 2319bc8471698b0b62ce0684382639f8dfc1cb99 Mon Sep 17 00:00:00 2001 From: Kseniia Antonova <73473519+xuniq@users.noreply.github.com> Date: Fri, 24 Sep 2021 10:58:47 +0300 Subject: [PATCH 2/4] Minor fixes Co-authored-by: Nick Volynkin --- doc/contributing/docs/markup/admonitions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/docs/markup/admonitions.rst b/doc/contributing/docs/markup/admonitions.rst index 7253b935ae..f1f49c87c4 100644 --- a/doc/contributing/docs/markup/admonitions.rst +++ b/doc/contributing/docs/markup/admonitions.rst @@ -44,7 +44,7 @@ In Tarantool we have 3 variants of css-style for admonitions: This block contains essential information that the user should know while doing something. - For example, the block :doc:`here ` is used to warn the user against + For example, the block :doc:`in Getting Started with Docker ` is used to warn the user against closing the terminal window. * Custom admonition: From 40d5c45aa374f08edd7730b6e8e4c743818b333a Mon Sep 17 00:00:00 2001 From: Kseniia Antonova <73473519+xuniq@users.noreply.github.com> Date: Fri, 24 Sep 2021 10:59:43 +0300 Subject: [PATCH 3/4] Minor fix Co-authored-by: Nick Volynkin --- doc/contributing/docs/markup/admonitions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/docs/markup/admonitions.rst b/doc/contributing/docs/markup/admonitions.rst index f1f49c87c4..91971d68fd 100644 --- a/doc/contributing/docs/markup/admonitions.rst +++ b/doc/contributing/docs/markup/admonitions.rst @@ -38,7 +38,7 @@ In Tarantool we have 3 variants of css-style for admonitions: .. code-block:: rst - .. IMPORTANT:: + .. important:: .. IMPORTANT:: From 525282d4244f1c4213b31f5fa59b69c82f053b41 Mon Sep 17 00:00:00 2001 From: Kseniia Antonova <73473519+xuniq@users.noreply.github.com> Date: Fri, 24 Sep 2021 11:00:09 +0300 Subject: [PATCH 4/4] Minor fix Co-authored-by: Nick Volynkin --- doc/contributing/docs/markup/admonitions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/docs/markup/admonitions.rst b/doc/contributing/docs/markup/admonitions.rst index 91971d68fd..118db7922c 100644 --- a/doc/contributing/docs/markup/admonitions.rst +++ b/doc/contributing/docs/markup/admonitions.rst @@ -40,7 +40,7 @@ In Tarantool we have 3 variants of css-style for admonitions: .. important:: - .. IMPORTANT:: + .. important:: This block contains essential information that the user should know while doing something.