Description
Original request:
"Мы начинаем рекомендовать нашим пользователям использовать tt на замену старым CLI инструментам.
При этом в документации осталось немало гайдов, где показано как сделать те или иные операции с помощью старых cli.
Наша задача актуализировать эти гайды и заменить все на команды tt cli.
Изменения необходимо выполнить в Tarantool 2.11, Tarantool EE 2.11.
Разделы относящиеся к tarantoolctl и cartridge-cli также пометить как deprecated и рекомендовать переходить на tt cli"
Description
tt CLI is released and ready to replace tarantoolctl
and cartridge-cli
. We need to adjust command-line instruction across Tarantool docs to use the new tool.
tt
must be the recommended Tarantool CLI since version 2.11. Thus, we will replace tarantoolctl
and cartridge-cli
in Tarantool CE and Tarantool EE 2.11 docs.
tarantoolctl
and cartridge-cli
must be marked as deprecated tools. Additionally, we should provide instructions on migration from them to tt
. They are available in the tt repo
The scope of work is defined in Notion. It includes:
- CE docs:
- 30-40 examples of tarantoolctl usage that require writing a tt alternative.
- 80 occurrences of the word
tarantoolctl
that can be trivially replaced withtt
. - 20 other occurrences
- EE docs:
- 11 occurrences of the word
tarantoolctl
that can be trivially replaced withtt
.
- 11 occurrences of the word
Pages affected the most
- Administration section
- https://www.tarantool.io/en/doc/latest/book/admin/start_stop_instance/
- https://www.tarantool.io/en/doc/latest/book/admin/daemon_supervision/
- https://www.tarantool.io/en/doc/latest/book/admin/instance_config/
- https://www.tarantool.io/en/doc/latest/book/admin/logs/
- https://www.tarantool.io/en/doc/latest/book/admin/server_introspection/
- https://www.tarantool.io/en/doc/latest/book/admin/troubleshoot/
- How-to
- EE docs:
Question
Q: Do we need to replace cartridge-cli
calls in Cartridge docs with tt
?
A: No, a deprecation note with a link to tt docs is enough for Cartridge docs.
Definition of done
- All command-line calls in Tarantool CE and EE docs use tt
- tarantoolctl reference page contains a deprecation note and a link to tt as a replacement
- cartridge docs contain a deprecation note for cartridge-cli (but still use it in cartridge-specific examples)
- Tarantool CE docs provide guidelines for migration from tarantoolctl and cartridge-cli to tt