Skip to content

Cartridge deprecation: remove Cartridge content from docs #3780

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

Merged
merged 7 commits into from
Oct 24, 2023

Conversation

p7nov
Copy link
Contributor

@p7nov p7nov commented Oct 20, 2023

Part of #3546 (content)

Deployment: https://docs.d.tarantool.io/en/doc/gh-3546-cartridge-deprecation/

  • Remove the Cluster on Cartridge top-level section with all contents from all ToCs: main, singlehtml, pdf.

  • Getting started: remove all nested pages as Cartridge-specific. Leave general description and link to the Creating a first DB tutorial.

  • How-to > Creating your first Tarantool Cartridge application: remove page

  • Concepts:

  • Tarantool Enterprise Edition:

    • main EE page: remove links to deleted section of dev guide (see below)
    • Setup: remove Cartridge-related parts (still needs rewriting)
    • Developer's guide: empty the section, set a TODO for rewriting
    • Cluster administrator's guide: empty the section, set a TODO for rewriting
    • Security audit: remove links to Cartridge docs
    • LDAP authorization: empty the section, set a TODO for rewriting
    • Migration: remove the section - delete the file and ToC item (non-applicable to new EE)
    • Modules: remove Cartridge and related modules
  • Reference > Tooling > tt CLI utility:

    • main tt page: remove link to migration instruction on Cartridge docs. To update the link when we add a migration section
    • Commands > tt cartridge: add a note that Cartridge is deprecated and incompatible with Tarantool 3+
  • Contributing > Guidelines > Documentation & Localization guidelines:

@p7nov p7nov marked this pull request as draft October 20, 2023 09:12
@p7nov p7nov marked this pull request as ready for review October 23, 2023 05:10
The :ref:`First steps <getting_started-imcp>` section
.. TODO: New Getting Started https://github.com/tarantool/doc/issues/3636

The :ref:`Creating your first Tarantool database <getting_started_db>` section
will get you acquainted with Tarantool in 15 minutes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove in 15 minutes - we cannot predict how much time a user will spend in this tutorial


The Tarantool Cartridge framework is deprecated and is not compatible with
Tarantool 3.0 and later. This command is added for backward compatibility with
earlier versions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also add a similar note for the --cartridge-compat option in the tt pack description:
https://docs.d.tarantool.io/en/doc/gh-3546-cartridge-deprecation/reference/tooling/tt_cli/pack/#options

@@ -60,9 +60,10 @@ Replacement for tarantooctl and Cartridge CLI
---------------------------------------------

A multi-purpose tool for working with Tarantool from the command line, ``tt`` has
come to replace :ref:`tarantoolctl <tarantoolctl>`
come to replace the deprecated utilities :ref:`tarantoolctl <tarantoolctl>`
and :doc:`Cartridge CLI </book/cartridge/cartridge_cli/index>` command-line utilities.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that Cartridge Command Line Interface is removed from docs, shouldn't we remove the /book/cartridge/cartridge_cli/index link?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants