Skip to content

Commit 1852877

Browse files
Build the new Cartridge CLI Readme (#2352)
* Build Cartridge CLI doc from multiple files Co-authored-by: Nick Volynkin <nick.volynkin@gmail.com> Co-authored-by: Patience Daur <patiencedaur@gmail.com>
1 parent ee7c36b commit 1852877

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

build_submodules.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ po_src="${project_root}/modules/cartridge/build.luarocks/build.rst/locale/ru/LC_
1313
po_dest="${project_root}/locale/ru/LC_MESSAGES/book/cartridge"
1414
cartridge_cli_root="${project_root}/modules/cartridge-cli/doc"
1515
cartridge_cli_dest="${rst_dest}/cartridge_cli"
16-
cartridge_cli_index_dest="${cartridge_cli_dest}/index.rst"
1716
monitoring_root="${project_root}/modules/metrics/doc/monitoring"
1817
monitoring_dest="${project_root}/doc/book"
1918
monitoring_grafana_root="${project_root}/modules/grafana-dashboard/doc/monitoring"
@@ -42,7 +41,8 @@ yes | cp -rf "${monitoring_root}" "${monitoring_dest}/"
4241
yes | cp -rf "${monitoring_grafana_root}" "${monitoring_dest}/"
4342

4443
mkdir -p "${cartridge_cli_dest}"
45-
yes | cp -rf "${cartridge_cli_root}/index.rst" "${cartridge_cli_index_dest}"
44+
cd ${cartridge_cli_root} || exit
45+
find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -rv --parents {} "${cartridge_cli_dest}" \;
4646

4747
mkdir -p "${cartridge_kubernetes_dest}"
4848
yes | cp -rf "${cartridge_kubernetes_root}" "${cartridge_kubernetes_dest}"

doc/getting_started/getting_started_cartridge.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Next, create an application named ``myapp``. Say:
1717
1818
This will create a Tarantool Cartridge application in the ``./myapp`` directory,
1919
with a handful of
20-
:ref:`template files and directories <cartridge-cli-creating_an_application_from_template>`
20+
:doc:`template files and directories </book/cartridge/cartridge_cli/commands/create>`
2121
inside.
2222

2323
Go inside and make a dry run:
@@ -222,5 +222,5 @@ Everything is up and running! What's next?
222222
cluster and try some cool cluster management features.
223223
* Get inspired with `these examples <https://github.com/tarantool/examples/>`_
224224
and implement more sophisticated business logic for your role.
225-
* :ref:`Pack <cartridge-cli-packing-an-application>` your application for easy distribution.
225+
* :doc:`Pack </book/cartridge/cartridge_cli/commands/pack>` your application for easy distribution.
226226
Choose what you like: a DEB or RPM package, a TGZ archive, or a Docker image.

locale/ru/LC_MESSAGES/getting_started/getting_started_cartridge.po

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ msgstr "$ cartridge create --name myapp"
2020

2121
msgid ""
2222
"This will create a Tarantool Cartridge application in the ``./myapp`` "
23-
"directory, with a handful of :ref:`template files and directories "
24-
"<cartridge-cli-creating_an_application_from_template>` inside."
23+
"directory, with a handful of :doc:`template files and directories "
24+
"</book/cartridge/cartridge_cli/commands/create>` inside."
2525
msgstr ""
2626
"Эта команда создает новое Tarantool Cartridge-приложение в директории "
27-
"``./myapp``. Там теперь содержатся созданные по шаблону :ref:`файлы и "
28-
"директории <cartridge-cli-creating_an_application_from_template>`."
27+
"``./myapp``. Там теперь содержатся созданные по шаблону :doc:`файлы и "
28+
"директории </book/cartridge/cartridge_cli/commands/create>`."
2929

3030
msgid "Go inside and make a dry run:"
3131
msgstr "Войдите внутрь этой директории и запустите ваше приложение:"
@@ -392,10 +392,10 @@ msgstr ""
392392
" для вашей роли."
393393

394394
msgid ""
395-
":ref:`Pack <cartridge-cli-packing-an-application>` your application for easy"
396-
" distribution. Choose what you like: a DEB or RPM package, a TGZ archive, or"
397-
" a Docker image."
395+
":doc:`Pack </book/cartridge/cartridge_cli/commands/pack>` your application "
396+
"for easy distribution. Choose what you like: a DEB or RPM package, a TGZ "
397+
"archive, or a Docker image."
398398
msgstr ""
399-
":ref:`Упакуйте <cartridge-cli-packing-an-application>` ваше приложение для "
400-
"дальнейшего распространения. Вы можете выбрать любой из поддерживаемых видов"
401-
" пакетов: DEB, RPM, архив TGZ или Docker-образ."
399+
":doc:`Упакуйте </book/cartridge/cartridge_cli/commands/pack>` ваше "
400+
"приложение для дальнейшего распространения. Вы можете выбрать любой из "
401+
"поддерживаемых видов пакетов: DEB, RPM, архив TGZ или Docker-образ."

0 commit comments

Comments
 (0)