New TOC structure (#1552)

Author: artembo

doc/book/admin/index.rst

@@ -1,7 +1,7 @@
 .. _admin:
 
 ********************************************************************************
-Server administration
+Administration
 ********************************************************************************
 
 Tarantool is designed to have multiple running instances on the same host.
@@ -36,3 +36,4 @@ This chapter includes the following sections:
    os_notes
    bug_reports
    troubleshoot
+   ../monitoring/index

doc/book/app_server/index.rst

@@ -4,7 +4,7 @@
 Application server
 ********************************************************************************
 
-In this chapter, we introduce the basics of working with Tarantool as a Lua
+Here we introduce the basics of working with Tarantool as a Lua
 application server.
 
 This chapter contains the following sections:

doc/book/box/atomic.rst

@@ -1,7 +1,7 @@
 .. _atomic-atomic_execution:
 
 ================================================================================
-Transaction control
+Transactions
 ================================================================================
 
 Transactions in Tarantool occur in **fibers** on a single **thread**.

doc/book/box/atomic_index.rst

@@ -0,0 +1,7 @@
+.. _atomic-atomic_execution:
+
+================================================================================
+Transaction control
+================================================================================
+
+.. include:: atomic.rst

doc/book/box/authentication_index.rst

@@ -0,0 +1,7 @@
+.. _authentication:
+
+================================================================================
+Access control
+================================================================================
+
+.. include:: authentication.rst

doc/book/box/data_model.rst

@@ -61,77 +61,13 @@ When Tarantool returns a tuple value in console, it uses the
 `YAML <https://en.wikipedia.org/wiki/YAML>`_ format,
 for example: ``[3, 'Ace of Base', 1993]``.
 
-
 .. _index-box_index:
 
 --------------------------------------------------------------------------------
 Index
 --------------------------------------------------------------------------------
 
-An **index** is a group of key values and pointers.
-
-As with spaces, you should specify the index **name**, and let Tarantool
-come up with a unique **numeric identifier** ("index id").
-
-An index always has a **type**. The default index type is 'TREE'.
-TREE indexes are provided by all Tarantool engines, can index unique and
-non-unique values, support partial key searches, comparisons and ordered results.
-Additionally, memtx engine supports HASH, RTREE and BITSET indexes.
-
-An index may be **multi-part**, that is, you can declare that an index key value
-is composed of two or more fields in the tuple, in any order.
-For example, for an ordinary TREE index, the maximum number of parts is 255.
-
-An index may be **unique**, that is, you can declare that it would be illegal
-to have the same key value twice.
-
-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.
-
-An index definition may include identifiers of tuple fields and their expected
-**types** (see allowed :ref:`indexed field types <index-box_indexed-field-types>`
-below).
-
-.. NOTE::
-
-  A recommended design pattern for a data model is to base primary keys on the
-  first fields of a tuple, because this speeds up tuple comparison.
-
-In our example, we first defined the primary index (named 'primary') based on
-field #1 of each tuple:
-
-.. code-block:: tarantoolsession
-
-   tarantool> i = s:create_index('primary', {type = 'hash', parts = {{field = 1, type = 'unsigned'}}}
-
-The effect is that, for all tuples in space 'tester', field #1 must exist and
-must contain an unsigned integer.
-The index type is 'hash', so values in field #1 must be unique, because keys
-in HASH indexes are unique.
-
-After that, we defined a secondary index (named 'secondary') based on field #2
-of each tuple:
-
-.. code-block:: tarantoolsession
-
-   tarantool> i = s:create_index('secondary', {type = 'tree', parts = {2, 'string'}})
-
-The effect is that, for all tuples in space 'tester', field #2 must exist and
-must contain a string.
-The index type is 'tree', so values in field #2 must not be unique, because keys
-in TREE indexes may be non-unique.
-
-.. NOTE::
-
-  Space definitions and index definitions are stored permanently in Tarantool's
-  system spaces :ref:`_space <box_space-space>` and :ref:`_index <box_space-index>`
-  (for details, see reference on :ref:`box.space <box_space>` submodule).
-
-  You can add, drop, or alter the definitions at runtime, with some restrictions.
-  See syntax details in reference on :ref:`box <box-module>` module.
-
-Read more about index operations :ref:`below <index-box_index-operations>`.
+.. include:: indexes.rst
 
 .. _index-box_data-types:
 

doc/book/box/indexes.rst

@@ -0,0 +1,68 @@
+********************************************************************************
+Indexes
+********************************************************************************
+
+An **index** is a group of key values and pointers.
+
+As with spaces, you should specify the index **name**, and let Tarantool
+come up with a unique **numeric identifier** ("index id").
+
+An index always has a **type**. The default index type is 'TREE'.
+TREE indexes are provided by all Tarantool engines, can index unique and
+non-unique values, support partial key searches, comparisons and ordered results.
+Additionally, memtx engine supports HASH, RTREE and BITSET indexes.
+
+An index may be **multi-part**, that is, you can declare that an index key value
+is composed of two or more fields in the tuple, in any order.
+For example, for an ordinary TREE index, the maximum number of parts is 255.
+
+An index may be **unique**, that is, you can declare that it would be illegal
+to have the same key value twice.
+
+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.
+
+An index definition may include identifiers of tuple fields and their expected
+**types** (see allowed :ref:`indexed field types <index-box_indexed-field-types>`
+below).
+
+.. NOTE::
+
+  A recommended design pattern for a data model is to base primary keys on the
+  first fields of a tuple, because this speeds up tuple comparison.
+
+In our example, we first defined the primary index (named 'primary') based on
+field #1 of each tuple:
+
+.. code-block:: tarantoolsession
+
+   tarantool> i = s:create_index('primary', {type = 'hash', parts = {{field = 1, type = 'unsigned'}}}
+
+The effect is that, for all tuples in space 'tester', field #1 must exist and
+must contain an unsigned integer.
+The index type is 'hash', so values in field #1 must be unique, because keys
+in HASH indexes are unique.
+
+After that, we defined a secondary index (named 'secondary') based on field #2
+of each tuple:
+
+.. code-block:: tarantoolsession
+
+   tarantool> i = s:create_index('secondary', {type = 'tree', parts = {2, 'string'}})
+
+The effect is that, for all tuples in space 'tester', field #2 must exist and
+must contain a string.
+The index type is 'tree', so values in field #2 must not be unique, because keys
+in TREE indexes may be non-unique.
+
+.. NOTE::
+
+  Space definitions and index definitions are stored permanently in Tarantool's
+  system spaces :ref:`_space <box_space-space>` and :ref:`_index <box_space-index>`
+  (for details, see reference on :ref:`box.space <box_space>` submodule).
+
+  You can add, drop, or alter the definitions at runtime, with some restrictions.
+  See syntax details in reference on :ref:`box <box-module>` module.
+
+Read more about index operations :ref:`here <index-box_index-operations>`.