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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions doc/book/cartridge/cartridge_overview.rst

This file was deleted.

Binary file removed doc/book/cartridge/images/auth_creds.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/bootstrap-vshard.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/change-weight.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/create-router.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/create-storage.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/edit-replica-set.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/enabled-failover.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/expelling-instance.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/failover-control.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/failover-priority.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/failover.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/final-cluster.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/join-new-set.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/join-router.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/join-storage.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/new-unconfig.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/probe-server.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/switch-master.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/unconfigured-router.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/users-tab.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/zero-weight.png
Binary file not shown.
Binary file removed doc/book/cartridge/images/zero.png
Binary file not shown.
1 change: 0 additions & 1 deletion doc/book/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ User's Guide
../how-to/index
../concepts/index
box/index
cartridge/index
admin/index
monitoring/index
connectors
Expand Down
9 changes: 1 addition & 8 deletions doc/concepts/data_model/schema_desc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,7 @@ The schema would look something like this:

This alternative is simpler to use, and you do not have to dive deep into Lua.

``DDL`` is a built-in
:doc:`Cartridge </book/cartridge/index>` module.
Cartridge is a cluster solution for Tarantool. In its WebUI, there is a separate tab
called "Code". On this tab, in the ``schema.yml`` file, you can define the schema, check its correctness,
and apply it to the whole cluster.

If you do not use Cartridge, you can still use the DDL module:
put the following Lua code into the file that you use to run Tarantool.
To use the DDL module, put the following Lua code into the file that you use to run Tarantool.
This file is usually called ``init.lua``.

.. code:: lua
Expand Down
4 changes: 0 additions & 4 deletions doc/concepts/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,6 @@ Application server
Using Tarantool as an application server, you can write
applications in Lua, C, or C++. You can also create reusable :ref:`modules <concepts-modules>`.

A convenient way to serve a clustered application on Tarantool is using :ref:`Tarantool Cartridge <tarantool-cartridge>` --
a framework for developing, deploying, and managing applications.

To increase the speed of code execution, Tarantool has a Lua Just-In-Time compiler (LuaJIT) on board.
LuaJIT compiles hot paths in the code -- paths that are used many times --
thus making the application work faster.
Expand Down Expand Up @@ -118,7 +115,6 @@ For details, check the :ref:`Storage engines <engines-chapter>` section.
coop_multitasking
atomic
modules
Tarantool Cartridge <https://tarantool.io/doc/latest/book/cartridge>
sharding/index
replication/index
triggers
Expand Down
5 changes: 2 additions & 3 deletions doc/concepts/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
Modules
=======

Any logic that is used in Tarantool can be packaged as an application
(like a :ref:`Cartridge application <tarantool-cartridge>`) or a reusable **module**.
A module is an optional library that enhances Tarantool functionality.
Any logic that is used in Tarantool can be packaged as an application or a reusable **module**.
A module is an optional library that extends Tarantool functionality.
It can be used by Tarantool applications or other modules.
Modules allow for easier code management and hot code reload without restarting the Tarantool instance.
Like applications, modules in Tarantool can be written in Lua,
Expand Down
31 changes: 2 additions & 29 deletions doc/contributing/docs/infra.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ The documentation source files are mainly stored in the
`documentation repository <https://github.com/tarantool/doc>`_.
However, in some cases, they are stored in the
repositories of other Tarantool-related products
or modules -- `Cartridge <https://github.com/tarantool/cartridge>`_,
`Monitoring <https://github.com/tarantool/metrics/tree/master/doc/monitoring>`__,
and others.
or modules, such as
`Monitoring <https://github.com/tarantool/metrics/tree/master/doc/monitoring>`__.

If you are working with source files from a product or module repository,
add that repository as a submodule to the
Expand Down Expand Up @@ -103,32 +102,6 @@ The ``${project_root}`` variable is defined earlier in the file as ``project_roo
This is because the documentation build has to start from the documentation repository root
directory.

cartridge_cli
^^^^^^^^^^^^^

The content source file for the ``cartridge_cli`` submodule is
``README.rst``, located in the directory of the submodule repository.
In the final documentation view, the content should appear here:
``https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_cli/``.

To make this work:

* Create a directory at ``./doc/book/cartridge/cartridge_cli``.
* Copy ``./modules/cartridge_cli/README.rst`` to
``./doc/book/cartridge/cartridge_cli/index.rst``.

Here ar the corresponding settings in ``build_submodules.sh``:

.. code-block:: bash

rst_dest="${project_root}/doc/book/cartridge"
cartridge_cli_root="${project_root}/modules/cartridge-cli"
cartridge_cli_dest="${rst_dest}/cartridge_cli"
cartridge_cli_index_dest="${cartridge_cli_dest}/index.rst"

mkdir -p "${cartridge_cli_dest}"
yes | cp -rf "${cartridge_cli_root}/README.rst" "${cartridge_cli_index_dest}"

.. _guidelines_doc_submodules_gitignore:

3. Update .gitignore
Expand Down

This file was deleted.

17 changes: 9 additions & 8 deletions doc/contributing/docs/localization/_includes/glossary.csv
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Term [en];Term [ru];Description [en];Description [ru]
space;спейс;A space is a container for tuples.;
;"https://www.tarantool.io/en/doc/latest/book/box/data_model/#spaces""";;NOUN
tuple;кортеж;A tuple plays the same role as a “row” or a “record”. The number of tuples in a space is unlimited. Tuples in Tarantool are stored as MsgPack arrays. https://www.tarantool.io/en/doc/latest/book/box/data_model/#tuples;
tuple;кортеж;A tuple plays the same role as a “row” or a “record”. The number of tuples in a space is unlimited. Tuples in Tarantool are stored as MsgPack arrays.;
Tarantool;Tarantool;НЕ ПЕРЕВОДИТЬ;
primary index;первичный индекс;The first index defined on a space is called the primary key index, and it must be unique. All other indexes are called secondary indexes, and they may be non-unique. https://www.tarantool.io/en/doc/latest/book/box/data_model/#indexes;
fiber;файбер;A fiber is a set of instructions which are executed with cooperative multitasking. Fibers managed by the fiber module are associated with a user-supplied function called the fiber function. https://www.tarantool.io/en/doc/latest/reference/reference_lua/fiber/#fibers;
Expand All @@ -16,8 +15,6 @@ implicit casting;неявное приведение типов;;
database;база данных;;
Release policy;Релизная политика;A set of rules for releasing and naming new distributions of Tarantool: where we add new features and where we don't, how we give them numbers, what versions are suitable to use in production.;
field;поле;Fields are distinct data values, contained in a tuple. They play the same role as «row columns» or «record fields» in relational databases.;
;;;
;"https://www.tarantool.io/ru/doc/latest/book/box/data_model/#term-field""";;NOUN
leader election;выборы лидера;(in a replica set, by the Raft algorithm);
replica set;набор реплик;;
heartbeat;контрольный сигнал;;
Expand All @@ -43,14 +40,18 @@ expression;выражение;;
predicate;предикат;(SQL) Predicates, which specify conditions that can be evaluated to SQL three-valued logic (3VL) (true/false/unknown) or Boolean truth values and are used to limit the effects of statements and queries, or to change program flow.;
query;запрос;(SQL) Queries retrieve the data based on specific criteria. A query is a statement that returns a result set (possibly empty).;
result set;результат запроса;(SQL) An SQL result set is a set of rows from a database, as well as metadata about the query such as the column names, and the types and sizes of each column. A result set is effectively a table.;
resultset;результат запроса;(SQL) An SQL result set is a set of rows from a database, as well as metadata about the query such as the column names, and the types and sizes of each column. A result set is effectively a table.;
statement;инструкция;(SQL) A statement is any text that the database engine recognizes as a valid command.;(SQL) Любой текст, который распознаётся движком БД как команда. Инструкция состоит из ключевых слов и выражений языка SQL, которые предписывают Tarantool выполнять какие-либо действия с базой данных.
;"Tarantool: A statement consists of SQL-language keywords and expressions that direct Tarantool to do something with a database. https://www.tarantool.io/en/doc/latest/reference/reference_sql/sql_user_guide/#statements""";;
;;"Tarantool: A statement consists of SQL-language keywords and expressions that direct Tarantool to do something with a database. https://www.tarantool.io/en/doc/latest/reference/reference_sql/sql_user_guide/#statements""";;
batch;пакет (инструкций);(SQL) A series of SQL statements sent to the server at once is called a batch.;(SQL) Серия SQL-инструкций (statements), отправляемая на сервер вместе
production configuration;конфигурация производственной среды;;
deployment;;Transforming a mechanical, electrical, or computer system from a packaged to an operational state. IT infrastructure deployment typically involves defining the sequence of operations or steps, often referred to as a deployment plan, that must be carried to deliver changes into a target system environment.;
deployment;развертывание;Transforming a mechanical, electrical, or computer system from a packaged to an operational state. IT infrastructure deployment typically involves defining the sequence of operations or steps, often referred to as a deployment plan, that must be carried to deliver changes into a target system environment.;
roll back;отменить;;транзакцию
deploy to production;;IT infrastructure deployment typically involves defining the sequence of operations or steps, often referred to as a deployment plan, that must be carried to deliver changes into a target system environment. Production environment is a setting where software and other products are actually put into operation for their intended uses by end users;
operations;эксплуатация;(DevOps) Information technology operations, or IT operations, are the set of all processes and services that are both provisioned by an IT staff to their internal or external clients and used by themselves, to run themselves as a business. ;
to deploy;;Transforming a mechanical, electrical, or computer system from a packaged to an operational state. IT infrastructure deployment typically involves defining the sequence of operations or steps, often referred to as a deployment plan, that must be carried to deliver changes into a target system environment.;
deployment plan;;A sequence of operations or steps that must be carried to deliver changes into a target system environment.;
deployment plan;;A sequence of operations or steps that must be carried to deliver changes into a target system environment.;
production environment;производственная среда;Production environment is a term used mostly by developers to describe the setting where software and other products are actually put into operation for their intended uses by end users.;
failover;восстановление после сбоев;In computing and related technologies such as networking, failover is switching to a redundant or standby computer server, system, hardware component or network upon the failure or abnormal termination of the previously active application, server, system, hardware component, or network.;
directory;директория;;
bucket;сегмент;;
select;выберите, выбрать;To select a checkbox;
10 changes: 0 additions & 10 deletions doc/contributing/docs/localization/glossaries.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
Glossaries
==========

Tarantool Core
--------------

.. csv-table::
:file: _includes/glossary.csv
:header-rows: 1
:delim: ;

Cartridge
---------

.. csv-table::
:file: _includes/glossary-cartridge.csv
:header-rows: 1
:delim: ;
14 changes: 0 additions & 14 deletions doc/contributing/docs/localization/locstate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,10 @@ State of localization
- |doc|
- 352 000

* - Cartridge
- |cartridge|
- 14 000

* - Tarantool Ansible Role
- |tarantool-ansible-role|
- 11 000

* - Cartridge CLI
- |cartridge-cli|
- 6 500

* - Tarantool Enterprise Edition
- |tarantool-enterprise|
- 6 000
Expand Down Expand Up @@ -58,12 +50,6 @@ State of localization
.. |doc| image:: https://badges.crowdin.net/tarantool-docs/localized.svg
:target: https://crowdin.com/project/tarantool-docs/ru#

.. |cartridge| image:: https://badges.crowdin.net/tarantool-cartridge-docs/localized.svg
:target: https://crowdin.com/project/tarantool-cartridge-docs/ru#

.. |cartridge-cli| image:: https://badges.crowdin.net/tarantool-cartridge-cli/localized.svg
:target: https://crowdin.com/project/tarantool-cartridge-cli/ru#

.. |tarantool-enterprise| image:: https://badges.crowdin.net/tarantool-enterprise-docs/localized.svg
:target: https://crowdin.com/project/tarantool-enterprise-docs/ru#

Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/docs/sphinx-warnings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ This may happen when you refer to a wrong path to a document.

Check the path.

If the path points to ``cartridge`` or another submodule, check that you've
If the path points to a submodule, check that you've
:doc:`built the submodules content </contributing/docs/build>`
before building docs.

Expand Down
Loading