Skip to content

Commit 28f00ea

Browse files
p7novandreyaksenov
authored andcommitted
Cartridge deprecation: remove Cartridge content from docs (#3780)
Part of #3546
1 parent 9ff70c7 commit 28f00ea

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+75
-1865
lines changed

doc/book/cartridge/cartridge_overview.rst

-48
This file was deleted.
-12.7 KB
Binary file not shown.
-19 KB
Binary file not shown.
-43.3 KB
Binary file not shown.
-29.4 KB
Binary file not shown.
-30.2 KB
Binary file not shown.
-32.4 KB
Binary file not shown.
-36.7 KB
Binary file not shown.
-11.7 KB
Binary file not shown.
-31.6 KB
Binary file not shown.
-46.8 KB
Binary file not shown.
-36.7 KB
Binary file not shown.
-96.4 KB
Binary file not shown.
-30 KB
Binary file not shown.
-13.4 KB
Binary file not shown.
-17.4 KB
Binary file not shown.
-29 KB
Binary file not shown.
-12.9 KB
Binary file not shown.
-29.3 KB
Binary file not shown.
Binary file not shown.
-45.5 KB
Binary file not shown.
-30.2 KB
Binary file not shown.

doc/book/cartridge/images/zero.png

-19.8 KB
Binary file not shown.

doc/book/index.rst

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ User's Guide
1515
../how-to/index
1616
../concepts/index
1717
box/index
18-
cartridge/index
1918
admin/index
2019
monitoring/index
2120
connectors

doc/concepts/data_model/schema_desc.rst

+1-8
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,7 @@ The schema would look something like this:
8686
8787
This alternative is simpler to use, and you do not have to dive deep into Lua.
8888

89-
``DDL`` is a built-in
90-
:doc:`Cartridge </book/cartridge/index>` module.
91-
Cartridge is a cluster solution for Tarantool. In its WebUI, there is a separate tab
92-
called "Code". On this tab, in the ``schema.yml`` file, you can define the schema, check its correctness,
93-
and apply it to the whole cluster.
94-
95-
If you do not use Cartridge, you can still use the DDL module:
96-
put the following Lua code into the file that you use to run Tarantool.
89+
To use the DDL module, put the following Lua code into the file that you use to run Tarantool.
9790
This file is usually called ``init.lua``.
9891

9992
.. code:: lua

doc/concepts/index.rst

-4
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,6 @@ Application server
5353
Using Tarantool as an application server, you can write
5454
applications in Lua, C, or C++. You can also create reusable :ref:`modules <concepts-modules>`.
5555

56-
A convenient way to serve a clustered application on Tarantool is using :ref:`Tarantool Cartridge <tarantool-cartridge>` --
57-
a framework for developing, deploying, and managing applications.
58-
5956
To increase the speed of code execution, Tarantool has a Lua Just-In-Time compiler (LuaJIT) on board.
6057
LuaJIT compiles hot paths in the code -- paths that are used many times --
6158
thus making the application work faster.
@@ -118,7 +115,6 @@ For details, check the :ref:`Storage engines <engines-chapter>` section.
118115
coop_multitasking
119116
atomic
120117
modules
121-
Tarantool Cartridge <https://tarantool.io/doc/latest/book/cartridge>
122118
sharding/index
123119
replication/index
124120
triggers

doc/concepts/modules.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33
Modules
44
=======
55

6-
Any logic that is used in Tarantool can be packaged as an application
7-
(like a :ref:`Cartridge application <tarantool-cartridge>`) or a reusable **module**.
8-
A module is an optional library that enhances Tarantool functionality.
6+
Any logic that is used in Tarantool can be packaged as an application or a reusable **module**.
7+
A module is an optional library that extends Tarantool functionality.
98
It can be used by Tarantool applications or other modules.
109
Modules allow for easier code management and hot code reload without restarting the Tarantool instance.
1110
Like applications, modules in Tarantool can be written in Lua,

doc/contributing/docs/infra.rst

+2-29
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ The documentation source files are mainly stored in the
1515
`documentation repository <https://github.com/tarantool/doc>`_.
1616
However, in some cases, they are stored in the
1717
repositories of other Tarantool-related products
18-
or modules -- `Cartridge <https://github.com/tarantool/cartridge>`_,
19-
`Monitoring <https://github.com/tarantool/metrics/tree/master/doc/monitoring>`__,
20-
and others.
18+
or modules, such as
19+
`Monitoring <https://github.com/tarantool/metrics/tree/master/doc/monitoring>`__.
2120

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

106-
cartridge_cli
107-
^^^^^^^^^^^^^
108-
109-
The content source file for the ``cartridge_cli`` submodule is
110-
``README.rst``, located in the directory of the submodule repository.
111-
In the final documentation view, the content should appear here:
112-
``https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_cli/``.
113-
114-
To make this work:
115-
116-
* Create a directory at ``./doc/book/cartridge/cartridge_cli``.
117-
* Copy ``./modules/cartridge_cli/README.rst`` to
118-
``./doc/book/cartridge/cartridge_cli/index.rst``.
119-
120-
Here ar the corresponding settings in ``build_submodules.sh``:
121-
122-
.. code-block:: bash
123-
124-
rst_dest="${project_root}/doc/book/cartridge"
125-
cartridge_cli_root="${project_root}/modules/cartridge-cli"
126-
cartridge_cli_dest="${rst_dest}/cartridge_cli"
127-
cartridge_cli_index_dest="${cartridge_cli_dest}/index.rst"
128-
129-
mkdir -p "${cartridge_cli_dest}"
130-
yes | cp -rf "${cartridge_cli_root}/README.rst" "${cartridge_cli_index_dest}"
131-
132105
.. _guidelines_doc_submodules_gitignore:
133106

134107
3. Update .gitignore

doc/contributing/docs/localization/_includes/glossary-cartridge.csv

-10
This file was deleted.

doc/contributing/docs/localization/_includes/glossary.csv

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Term [en];Term [ru];Description [en];Description [ru]
22
space;спейс;A space is a container for tuples.;
3-
;"https://www.tarantool.io/en/doc/latest/book/box/data_model/#spaces""";;NOUN
4-
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;
3+
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.;
54
Tarantool;Tarantool;НЕ ПЕРЕВОДИТЬ;
65
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;
76
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;
@@ -16,8 +15,6 @@ implicit casting;неявное приведение типов;;
1615
database;база данных;;
1716
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.;
1817
field;поле;Fields are distinct data values, contained in a tuple. They play the same role as «row columns» or «record fields» in relational databases.;
19-
;;;
20-
;"https://www.tarantool.io/ru/doc/latest/book/box/data_model/#term-field""";;NOUN
2118
leader election;выборы лидера;(in a replica set, by the Raft algorithm);
2219
replica set;набор реплик;;
2320
heartbeat;контрольный сигнал;;
@@ -43,14 +40,18 @@ expression;выражение;;
4340
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.;
4441
query;запрос;(SQL) Queries retrieve the data based on specific criteria. A query is a statement that returns a result set (possibly empty).;
4542
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.;
46-
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.;
4743
statement;инструкция;(SQL) A statement is any text that the database engine recognizes as a valid command.;(SQL) Любой текст, который распознаётся движком БД как команда. Инструкция состоит из ключевых слов и выражений языка SQL, которые предписывают Tarantool выполнять какие-либо действия с базой данных.
48-
;"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""";;
44+
;;"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""";;
4945
batch;пакет (инструкций);(SQL) A series of SQL statements sent to the server at once is called a batch.;(SQL) Серия SQL-инструкций (statements), отправляемая на сервер вместе
5046
production configuration;конфигурация производственной среды;;
51-
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.;
47+
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.;
5248
roll back;отменить;;транзакцию
5349
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;
5450
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. ;
5551
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.;
56-
deployment plan;;A sequence of operations or steps that must be carried to deliver changes into a target system environment.;
52+
deployment plan;;A sequence of operations or steps that must be carried to deliver changes into a target system environment.;
53+
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.;
54+
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.;
55+
directory;директория;;
56+
bucket;сегмент;;
57+
select;выберите, выбрать;To select a checkbox;
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,8 @@
11
Glossaries
22
==========
33

4-
Tarantool Core
5-
--------------
6-
74
.. csv-table::
85
:file: _includes/glossary.csv
96
:header-rows: 1
107
:delim: ;
118

12-
Cartridge
13-
---------
14-
15-
.. csv-table::
16-
:file: _includes/glossary-cartridge.csv
17-
:header-rows: 1
18-
:delim: ;

doc/contributing/docs/localization/locstate.rst

-14
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,10 @@ State of localization
1515
- |doc|
1616
- 352 000
1717

18-
* - Cartridge
19-
- |cartridge|
20-
- 14 000
21-
2218
* - Tarantool Ansible Role
2319
- |tarantool-ansible-role|
2420
- 11 000
2521

26-
* - Cartridge CLI
27-
- |cartridge-cli|
28-
- 6 500
29-
3022
* - Tarantool Enterprise Edition
3123
- |tarantool-enterprise|
3224
- 6 000
@@ -58,12 +50,6 @@ State of localization
5850
.. |doc| image:: https://badges.crowdin.net/tarantool-docs/localized.svg
5951
:target: https://crowdin.com/project/tarantool-docs/ru#
6052

61-
.. |cartridge| image:: https://badges.crowdin.net/tarantool-cartridge-docs/localized.svg
62-
:target: https://crowdin.com/project/tarantool-cartridge-docs/ru#
63-
64-
.. |cartridge-cli| image:: https://badges.crowdin.net/tarantool-cartridge-cli/localized.svg
65-
:target: https://crowdin.com/project/tarantool-cartridge-cli/ru#
66-
6753
.. |tarantool-enterprise| image:: https://badges.crowdin.net/tarantool-enterprise-docs/localized.svg
6854
:target: https://crowdin.com/project/tarantool-enterprise-docs/ru#
6955

doc/contributing/docs/sphinx-warnings.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ This may happen when you refer to a wrong path to a document.
163163

164164
Check the path.
165165

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

0 commit comments

Comments
 (0)