update doc for cartridge release 2.16.2

.github/workflows/push-pot.yml

@@ -0,0 +1,34 @@
+name: Push POTs
+on:
+  push:
+    branches:
+      - 'latest'
+permissions:
+  contents: write
+jobs:
+  generate-pot:
+    runs-on: ubuntu-latest
+    container: tarantool/doc-builder:fat-4.3
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Generate Portable Object Templates
+        run: |
+         cmake .
+         make update-pot  
+
+      - name: Commit generated pots
+        run: |
+          git config --global --add safe.directory /__w/doc/doc
+          git config --global user.name 'TarantoolBot'
+          git config --global user.email '[email protected]'
+
+          if [[ $(git status) =~ .*"nothing to commit".* ]]; then
+            echo "status=nothing-to-commit"
+            exit 0
+          fi
+
+          git add locale/en
+          git commit -m "updated pot"
+          git push origin 3.0 
+

.github/workflows/upload-docx.yml

@@ -1,11 +1,11 @@
 name: Generate DOCX
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - 'latest'
-      - '3.0'
-      - 'fix-docx'
+      - '2.11'
 
 jobs:
   generate-singlehtml:
@@ -28,7 +28,7 @@ jobs:
           make singlehtml
 
       - name: save singlehtml-en
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: singlehtml-en
           path: output/singlehtml/en/alternate_build_master.html
@@ -37,13 +37,13 @@ jobs:
         run: make singlehtml-ru
 
       - name: save singlehtml-ru
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: singlehtml-ru
           path: output/singlehtml/ru/alternate_build_master.html
 
       - name: save pandoc filters from the repo
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pandoc
           path: pandoc/filter-espd.py
@@ -60,7 +60,7 @@ jobs:
       S3_UPLOAD_PATH: ${{secrets.S3_DOCX_PATH}}
     steps:
       - name: download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
 
       - name: generate docx-en
         run: |

.gitignore

@@ -29,6 +29,7 @@ webhooks/.env
 
 locale/*
 !locale/ru
+!locale/en
 
 # redundant folders created by sphinx
 
@@ -75,6 +76,6 @@ locale/*
 
 # tntcxx submodule
 
-/doc/how-to/getting_started_cxx.rst
-/doc/how-to/_includes
-/doc/book/connectors/cxx/
+/doc/getting_started_cxx.rst
+/doc/_includes
+/doc/connector/cxx/

.gitmodules

@@ -1,18 +1,6 @@
-[submodule "modules/cartridge"]
-	path = modules/cartridge
-	url = https://github.com/tarantool/cartridge.git
-[submodule "modules/cartridge-cli"]
-	path = modules/cartridge-cli
-	url = https://github.com/tarantool/cartridge-cli.git
-[submodule "modules/metrics"]
-	path = modules/metrics
-	url = https://github.com/tarantool/metrics.git
 [submodule "modules/luatest"]
 	path = modules/luatest
 	url = https://github.com/tarantool/luatest
-[submodule "modules/grafana-dashboard"]
-	path = modules/grafana-dashboard
-	url = https://github.com/tarantool/grafana-dashboard
 [submodule "modules/tntcxx"]
 	path = modules/tntcxx
 	url = https://github.com/tarantool/tntcxx.git

README.rst

@@ -159,7 +159,7 @@ Its configuration is placed in the ``vale.ini`` file located in the root project
 To enable RST support in Vale, you need to install Sphinx.
 Then, you can enable Vale integration in your IDE, for example:
 
-*   `VS Code <https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server>`_
+*   `VS Code <https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode>`_
 *   `IntelliJ-based IDEs <https://plugins.jetbrains.com/plugin/16136-grazie-professional/docs/project-style-guides.html#vanilla-vale>`_
 
 

build_submodules.sh

@@ -11,62 +11,6 @@ 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"
-
-# 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"
-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"
-cd "${cartridge_pot_src}" || exit
-mkdir -p "${cartridge_pot_dest}"
-find . -name '*.pot' -exec cp -rv --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 -rv --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}" \;
-
-# 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"
-
-# Copy monitoring docs to the right destination
-mkdir -p "${monitoring_dest}"
-cp -rfv "${monitoring_root}" "${monitoring_dest}/"
-cp -rfv "${monitoring_grafana_root}" "${monitoring_dest}/"
-
-
 # Luatest
 luatest_root="${project_root}/modules/luatest"
 luatest_dest="${project_root}/doc/reference/reference_rock/luatest"
@@ -84,12 +28,13 @@ mv -fv "${luatest_dest}/index.rst" "${luatest_dest}/_includes/"
 
 # Tarantool C++ connector
 tntcxx_root="${project_root}/modules/tntcxx"
-tntcxx_howto_dest="${project_root}/doc/how-to"
-tntcxx_api_dest="${project_root}/doc/book/connectors"
+tntcxx_howto_dest="${project_root}/doc/connector"
+tntcxx_api_dest="${project_root}/doc/connector"
 
 # Copy Tarantool C++ connector docs to the right places
 mkdir -p "${tntcxx_api_dest}/cxx/"
-mkdir -p "${tntcxx_howto_dest}/_includes"
-cp -rfv "${tntcxx_root}/doc/tntcxx_getting_started.rst" "${tntcxx_howto_dest}/getting_started_cxx.rst"
-cp -rfv "${tntcxx_root}/examples/" "${tntcxx_howto_dest}/_includes/examples/"
+mkdir -p "${tntcxx_howto_dest}/cxx/"
+mkdir -p "${tntcxx_howto_dest}/cxx/_includes/"
+cp -rfv "${tntcxx_root}/doc/tntcxx_getting_started.rst" "${tntcxx_howto_dest}/cxx/"
+cp -rfv "${tntcxx_root}/examples/" "${tntcxx_howto_dest}/cxx/_includes/examples/"
 cp -rfv "${tntcxx_root}/doc/tntcxx_api.rst" "${tntcxx_api_dest}/cxx/"

conf.py

@@ -61,7 +61,7 @@
 project = u'Tarantool'
 
 # |release| The full version, including alpha/beta/rc tags.
-release = "2.11.1"
+release = "3.0.0"
 # |version| The short X.Y version.
 version = '.'.join(release.split('.')[0:2])
 
@@ -73,10 +73,6 @@
     'how-to/using_docker.rst',
     'reference/configuration/cfg_*',
     'images',
-    'book/cartridge/cartridge_overview.rst',
-    'book/cartridge/CONTRIBUTING.rst',
-    'book/cartridge/topics',
-    'book/cartridge/cartridge_api/modules/cartridge.test-helpers.rst',
     'reference/reference_rock/luatest/README.rst',
     'reference/reference_rock/luatest/modules/luatest.rst',
     '**/_includes/*'