Skip to content

Deprecate tarantoolctl and cartridge-cli in docs #3501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
4 tasks done
NeraverinTarantool opened this issue Jun 7, 2023 · 2 comments · Fixed by #3706
Closed
4 tasks done

Deprecate tarantoolctl and cartridge-cli in docs #3501

NeraverinTarantool opened this issue Jun 7, 2023 · 2 comments · Fixed by #3706
Assignees
Labels
2.11 2.11 release and the associated technical debt deprecation [nature] Deprecated functionality epic restructure Related to the transfer of sections, text. tt cli

Comments

@NeraverinTarantool
Copy link

NeraverinTarantool commented Jun 7, 2023

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
@NeraverinTarantool NeraverinTarantool added the deprecation [nature] Deprecated functionality label Jun 7, 2023
@veod32 veod32 added the tt cli label Jun 8, 2023
@p7nov
Copy link
Contributor

p7nov commented Jun 19, 2023

Фронт работ:
В tarantool/doc:

  • 🛠️ ~30-40 вхождений: требуется написание и тестирование аналогичных вызовов tt.
  • 🍹 ~80 вхождений: тривиальна замена – упоминание названия в тексте.
  • ~20 погрешность - относятся к одной из категорий выше.

В tarantool/enterprise-doc: 11 вхождений tarantoolctl, все тривиальны.

Дополнительно: в репо tarantool/tt есть инструкции по миграции со старых утилит. Добавим их в соответствующие разделы доки.

Подробнее в Notion.

@p7nov
Copy link
Contributor

p7nov commented Sep 19, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.11 2.11 release and the associated technical debt deprecation [nature] Deprecated functionality epic restructure Related to the transfer of sections, text. tt cli
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants