Skip to content

Deprecate tarantoolctl and cartridge-cli in docs #3501

Closed
@NeraverinTarantool

Description

@NeraverinTarantool

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 with tt.
    • 20 other occurrences
  • EE docs:
    • 11 occurrences of the word tarantoolctl that can be trivially replaced with tt.

Pages affected the most

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

Metadata

Metadata

Assignees

Labels

2.112.11 release and the associated technical debtdeprecation[nature] Deprecated functionalityepicrestructureRelated to the transfer of sections, text.tt cli

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions