Merge branch 'latest' into pgulutzan-gh-538

Author: patiencedaur

.github/ISSUE_TEMPLATE/document.md

@@ -1,7 +1,7 @@
 ---
 name: Write or update
 about: Write or update a documentation page
-title: "[0pt] {feature_name}"
+title: "{feature_name}"
 labels: 
 assignees:
 ---

.github/ISSUE_TEMPLATE/fix.md

@@ -1,7 +1,7 @@
 ---
 name: Fix & proofread
 about: Fix typos, proofread document
-title: "[0pt] Fix {document_title}"
+title: "Fix {document_title}"
 labels: typo
 assignees:
 ---

.github/ISSUE_TEMPLATE/tech.md

@@ -1,7 +1,7 @@
 ---
 name: Technical/internal issue
 about: Technical issue in the docs
-title: "[0pt] {do X}"
+title: "{do X}"
 labels: internal
 assignees:
 ---

.github/ISSUE_TEMPLATE/translate.md

@@ -32,8 +32,6 @@ jobs:
       - run: make build-modules
       - run: make json
       - run: make json-ru
-      - run: make singlehtml
-      - run: make singlehtml-ru
       - run: make pdf
       - run: make pdf-ru
       - uses: nelonoel/[email protected]

.github/ISSUE_TEMPLATE/versions.md

@@ -240,7 +240,7 @@ add_custom_target(update-pot
     COMMENT "Update translation sources"
 )
 
-add_custom_target(update-po-no-force
+add_custom_target(update-po
     COMMAND "${SPHINX_INTL_EXECUTABLE}"
         update
         -p "${CMAKE_CURRENT_SOURCE_DIR}/locale/en/"
@@ -267,13 +267,6 @@ add_custom_target(cleanup-pot
     COMMENT "Cleanup and rearrange POT files"
 )
 
-add_custom_target(update-po
-    COMMAND make
-        add-fake-msg
-        update-po-no-force
-        rm-fake-msg
-)
-
 add_custom_target(linkcheck
     COMMAND "${SPHINX_EXECUTABLE}"
         -b linkcheck

.github/workflows/add-issues-to-project.yml

@@ -3,73 +3,107 @@
 set -xe
 
 project_root=$(pwd)
-echo "${project_root}"
+
+# Translations
 po_dest="${project_root}/locale/ru/LC_MESSAGES"
+
+
+# Copy Building Tarantool Docs guide
+cp README.rst doc/contributing/docs/_includes/README.rst
+
+
+# Cartridge
 cartridge_root="${project_root}/modules/cartridge"
-cartridge_rst_src="${project_root}/modules/cartridge/build.luarocks/build.rst"
+
+# Build Cartridge to extract docs
+cd "${cartridge_root}" || exit
+CMAKE_DUMMY_WEBUI=true tarantoolctl rocks make
+
+# Copy Cartridge docs, including diagrams and images
+cartridge_rst_src="${cartridge_root}/build.luarocks/build.rst"
 cartridge_rst_dest="${project_root}/doc/book/cartridge"
-cartridge_pot_src="${project_root}/modules/cartridge/build.luarocks/build.rst/locale"
+cd "${cartridge_rst_src}" || exit
+mkdir -p "${cartridge_rst_dest}"
+find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -r --parents {} "${cartridge_rst_dest}" \;
+
+# Copy translation templates
+cartridge_pot_src="${cartridge_root}/build.luarocks/build.rst/locale"
 cartridge_pot_dest="${project_root}/locale/book/cartridge"
-cartridge_po_src="${project_root}/modules/cartridge/build.luarocks/build.rst/locale/ru/LC_MESSAGES"
+cd "${cartridge_pot_src}" || exit
+mkdir -p "${cartridge_pot_dest}"
+find . -name '*.pot' -exec cp -r --parents {} "${cartridge_pot_dest}" \;
+
+# Copy translations
+cartridge_po_src="${cartridge_root}/build.luarocks/build.rst/locale/ru/LC_MESSAGES"
 cartridge_po_dest="${po_dest}/book/cartridge"
+cd "${cartridge_po_src}" || exit
+mkdir -p "${cartridge_po_dest}"
+find . -name '*.po' -exec cp -r --parents {} "${cartridge_po_dest}" \;
+
+
+# Cartridge CLI
 cartridge_cli_root="${project_root}/modules/cartridge-cli/doc"
 cartridge_cli_dest="${cartridge_rst_dest}/cartridge_cli"
 cartridge_cli_po_dest="${po_dest}/book/cartridge/cartridge_cli"
+
+# Copy Cartridge CLI docs, including diagrams and images
+mkdir -p "${cartridge_cli_dest}"
+cd ${cartridge_cli_root} || exit
+find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -rv --parents {} "${cartridge_cli_dest}" \;
+
+# Copy translations
+mkdir -p "${cartridge_cli_po_dest}"
+cd "${cartridge_cli_root}/locale/ru/LC_MESSAGES/doc/" || exit
+find . -name '*.po' -exec cp -rv --parents {} "${cartridge_cli_po_dest}" \;
+
+# Add Cartridge Kubernetes guide to the Cartridge toctree right after Cartridge CLI
+sed -i -e '/Cartridge CLI <cartridge_cli\/index>/a\' -e '\ \ \ Cartridge Kubernetes guide <cartridge_kubernetes_guide/index>' "${cartridge_rst_dest}/index.rst"
+
+
+# Monitoring
 monitoring_root="${project_root}/modules/metrics/doc/monitoring"
 monitoring_dest="${project_root}/doc/book"
 monitoring_grafana_root="${project_root}/modules/grafana-dashboard/doc/monitoring"
-luatest_root="${project_root}/modules/luatest"
-luatest_dest="${project_root}/doc/reference/reference_rock/luatest"
 
-cartridge_kubernetes_root="${project_root}/modules/tarantool-operator/doc/cartridge_kubernetes_guide"
-cartridge_kubernetes_dest="${cartridge_rst_dest}/"
+# Copy monitoring docs to the right destination
+mkdir -p "${monitoring_dest}"
+yes | cp -rf "${monitoring_root}" "${monitoring_dest}/"
+yes | cp -rf "${monitoring_grafana_root}" "${monitoring_dest}/"
 
-tntcxx_root="${project_root}/modules/tntcxx"
-tntcxx_gs_dest="${project_root}/doc/getting_started"
-tntcxx_api_dest="${project_root}/doc/book/connectors"
 
-cp README.rst doc/contributing/docs/_includes/README.rst
+# Luatest
+luatest_root="${project_root}/modules/luatest"
+luatest_dest="${project_root}/doc/reference/reference_rock/luatest"
 
-mkdir -p "${luatest_dest}/_includes/"
+# Generate Luatest docs
 cd "${luatest_root}"
 ldoc --ext=rst --dir=rst --toctree="API" .
+
+# Copy Luatest docs to the right place
 cd "${luatest_dest}"
 yes | cp -fa "${luatest_root}/rst/." "${luatest_dest}"
 yes | cp "${luatest_root}/README.rst" "${luatest_dest}"
+mkdir -p "${luatest_dest}/_includes/"
 yes | mv -f "${luatest_dest}/index.rst" "${luatest_dest}/_includes/"
 
-mkdir -p "${monitoring_dest}"
-yes | cp -rf "${monitoring_root}" "${monitoring_dest}/"
-yes | cp -rf "${monitoring_grafana_root}" "${monitoring_dest}/"
 
-mkdir -p "${cartridge_cli_dest}" "${cartridge_cli_po_dest}"
-cd ${cartridge_cli_root} || exit
-find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -rv --parents {} "${cartridge_cli_dest}" \;
-cd "${cartridge_cli_root}/locale/ru/LC_MESSAGES/doc/" || exit
-find . -name '*.po' -exec cp -rv --parents {} "${cartridge_cli_po_dest}" \;
+# Kubernetes operator
+cartridge_kubernetes_root="${project_root}/modules/tarantool-operator/doc/cartridge_kubernetes_guide"
+cartridge_kubernetes_dest="${cartridge_rst_dest}/"
 
+# Copy Kubernetes operator docs to the right place
 mkdir -p "${cartridge_kubernetes_dest}"
 yes | cp -rf "${cartridge_kubernetes_root}" "${cartridge_kubernetes_dest}"
 
+
+# Tarantool C++ connector
+tntcxx_root="${project_root}/modules/tntcxx"
+tntcxx_gs_dest="${project_root}/doc/getting_started"
+tntcxx_api_dest="${project_root}/doc/book/connectors"
+
+# Copy Tarantool C++ connector docs to the right places
 mkdir -p "${tntcxx_api_dest}/cxx/"
 mkdir -p "${tntcxx_gs_dest}/_includes"
 yes | cp -rf "${tntcxx_root}/doc/tntcxx_getting_started.rst" "${tntcxx_gs_dest}/getting_started_cxx.rst"
 yes | cp -rf "${tntcxx_root}/examples/" "${tntcxx_gs_dest}/_includes/examples/"
 yes | cp -rf "${tntcxx_root}/doc/tntcxx_api.rst" "${tntcxx_api_dest}/cxx/"
-
-cd "${cartridge_root}" || exit
-CMAKE_DUMMY_WEBUI=true tarantoolctl rocks make
-
-cd "${cartridge_rst_src}" || exit
-mkdir -p "${cartridge_rst_dest}"
-find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -r --parents {} "${cartridge_rst_dest}" \;
-
-cd "${cartridge_pot_src}" || exit
-mkdir -p "${cartridge_pot_dest}"
-find . -name '*.pot' -exec cp -r --parents {} "${cartridge_pot_dest}" \;
-
-cd "${cartridge_po_src}" || exit
-mkdir -p "${cartridge_po_dest}"
-find . -name '*.po' -exec cp -r --parents {} "${cartridge_po_dest}" \;
-
-sed -i -e '/Cartridge CLI<cartridge_cli\/index>/a\' -e '\ \ \ Cartridge Kubernetes guide<cartridge_kubernetes_guide/index>' "${cartridge_rst_dest}/index.rst"

.github/workflows/main.yml

@@ -3,7 +3,7 @@
 .. _shard-module:
 
 -------------------------------------------------------------------------------
-                            Module `shard`
+                            Module shard
 -------------------------------------------------------------------------------
 
 .. module:: shard

CMakeLists.txt

@@ -1,7 +1,7 @@
 .. previous location: doc/reference/reference_rock/tdb.rst
 
 -------------------------------------------------------------------------------
-                            Module `tdb`
+                            Module tdb
 -------------------------------------------------------------------------------
 
 The Tarantool Debugger (abbreviation = ``tdb``) can be used with any Lua program.

build_submodules.sh

@@ -1,3 +1,6 @@
+:noindex:
+:fullwidth:
+
 .. _admin:
 
 ********************************************************************************

doc/archive/shard.rst

@@ -650,7 +650,7 @@ does 500,000 inserts and deletes in a Tarantool space.
 Start the profiler, execute the function, stop the
 profiler, and show what the profiler sampled.
 
-.. code-block:: none
+.. code-block:: lua
 
     box.space.t:drop()
     box.schema.space.create('t')

doc/archive/tdb.rst

@@ -4,6 +4,9 @@
 Upgrades
 ================================================================================
 
+For information about backwards compatibility,
+see the :ref:`compatibility guarantees <compatibility_guarantees>` description.
+
 .. _admin-upgrades_db:
 
 --------------------------------------------------------------------------------

doc/book/admin/index.rst

@@ -1,3 +1,5 @@
+:fullwidth:
+
 .. _engines-chapter:
 
 Storage engines
@@ -9,53 +11,11 @@ retrieve :term:`tuple <tuple>` values. Tarantool offers a choice of two storage
 *   :doc:`memtx <memtx>` is the in-memory storage engine used by default.
 *   :doc:`vinyl <vinyl>` is the on-disk storage engine.
 
-Below you can find comparing of the two engines in brief.
-All the details on how each engine works you can find in the dedicated
-sections:
+All the details on the engines you can find in the dedicated sections:
 
 .. toctree::
    :maxdepth: 1
 
    memtx
    vinyl
-
-.. _vinyl_diff:
-
-Difference between memtx and vinyl storage engines
---------------------------------------------------
-
-The primary difference between memtx and vinyl is that memtx is an in-memory
-engine while vinyl is an on-disk engine. An in-memory storage engine is
-generally faster (each query is usually run under 1 ms), and the memtx engine
-is justifiably the default for Tarantool. But on-disk engine such as vinyl is
-preferable when the database is larger than the available memory, and adding more
-memory is not a realistic option.
-
-.. container:: table
-
-    .. rst-class:: left-align-column-1
-    .. rst-class:: left-align-column-2
-
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | Option                                      | memtx                                                | vinyl                                                |
-    +=============================================+======================================================+======================================================+
-    | Supported index type                        | TREE, HASH, :ref:`RTREE <box_index-rtree>` or BITSET | TREE                                                 |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | Temporary spaces                            | Supported                                            | Not supported                                        |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | :ref:`random() <box_index-random>` function | Supported                                            | Not supported                                        |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | :ref:`alter() <box_index-alter>` function   | Supported                                            | Supported starting from the 1.10.2 release           |
-    |                                             |                                                      | (the primary index cannot be modified)               |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | :ref:`len() <box_space-len>` function       | Returns the number of tuples in the space            | Returns the maximum approximate number of tuples in  |
-    |                                             |                                                      | the space                                            |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | :ref:`count() <box_index-count>` function   | Takes a constant amount of time                      | Takes a variable amount of time depending on a state |
-    |                                             |                                                      | of a DB                                              |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | :ref:`delete() <box_space-delete>` function | Returns the deleted tuple, if any                    | Always returns nil                                   |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
-    | yield                                       | Does not yield on the select requests unless the     | Yields on the select requests or on its equivalents: |
-    |                                             | transaction is committed to WAL                      | get() or pairs()                                     |
-    +---------------------------------------------+------------------------------------------------------+------------------------------------------------------+
+   memtx_vinyl_diff