Skip to content

Update docs structure #4383

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 82 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
82 commits
Select commit Hold shift + click to select a range
55e112a
Move 'Tooling' at the top level
andreyaksenov Jul 22, 2024
bca9d58
Add topics to the 'Getting Started' section
andreyaksenov Jul 23, 2024
3fdcb33
Merge topics for Connectors
andreyaksenov Jul 23, 2024
09ae81c
Add C++ connector docs
andreyaksenov Jul 23, 2024
a9bb71f
Move the 'Compress' module to API reference
andreyaksenov Jul 23, 2024
9355f66
Create the 'Platform' entry and move some topics
andreyaksenov Jul 23, 2024
26c61b0
Update 'alternate_build_master'
andreyaksenov Jul 23, 2024
20c457e
Move more topics to 'Platform'
andreyaksenov Jul 23, 2024
0be2e47
Remove unused images
andreyaksenov Jul 23, 2024
8b4d931
Move Read views APIs to reference
andreyaksenov Jul 24, 2024
3fd67e0
Create the 'Defining and manipulating data' section and move content
andreyaksenov Jul 24, 2024
7703d56
Rename 'Platform guide'
andreyaksenov Jul 24, 2024
8179708
Add community connectors
andreyaksenov Jul 24, 2024
a3baff0
Remove Cpp example and docs
andreyaksenov Jul 24, 2024
6d1494c
Update Cpp connector docs
andreyaksenov Jul 24, 2024
70b1d6c
Fix includes
andreyaksenov Jul 24, 2024
1ccc869
Update 'build_submodules.sh' and gitignore
andreyaksenov Jul 24, 2024
06c31ca
Move the 'Replication' and 'Application' sections
andreyaksenov Jul 24, 2024
663e827
Duplicate anchor
andreyaksenov Jul 24, 2024
284aedf
Move 'Understanding the binary protocol'
andreyaksenov Jul 24, 2024
9b02508
Move 'libslave' and remove How-to
andreyaksenov Jul 24, 2024
b3c9428
Move more sections from 'Concepts'
andreyaksenov Jul 24, 2024
3db3907
Fix broken includes
andreyaksenov Jul 24, 2024
149ef77
Move vshard admin
andreyaksenov Jul 24, 2024
6e4c987
Create the 'Security' section
andreyaksenov Jul 24, 2024
a00c5f9
Move flight recorder
andreyaksenov Jul 24, 2024
cc91dde
Move CRUD operations
andreyaksenov Jul 24, 2024
e800fed
Flight recorder admonition
andreyaksenov Jul 24, 2024
b8796f8
Fix image
andreyaksenov Jul 24, 2024
0c8ce82
Move Enterprise modules
andreyaksenov Jul 24, 2024
6f89c76
Move Enterprise index
andreyaksenov Jul 24, 2024
f92fcf4
Fix broken include
andreyaksenov Jul 24, 2024
a273168
Fix indents
andreyaksenov Jul 24, 2024
51fdedc
Fix 'Explicit markup ends without a blank line'
andreyaksenov Jul 24, 2024
b41148f
Update Enterprise overview
andreyaksenov Jul 24, 2024
74f3c21
Remove CRUD operations
andreyaksenov Jul 24, 2024
8b508e2
Update Tarantool - Documentation
andreyaksenov Jul 24, 2024
5b1a9f1
Add missing sections
andreyaksenov Jul 24, 2024
cf6cbb3
Add EE link
andreyaksenov Jul 24, 2024
5a4dc4f
Remove libslave
andreyaksenov Jul 24, 2024
e408b06
Remove a duplicated topic
andreyaksenov Jul 24, 2024
95c8ba3
Move Enterprise modules
andreyaksenov Jul 24, 2024
1b473b3
Audit EE admonition
andreyaksenov Jul 24, 2024
67830e1
Fix macOS spelling
andreyaksenov Jul 25, 2024
055fa77
Add intros
andreyaksenov Jul 25, 2024
30809f9
fix article
andreyaksenov Jul 25, 2024
0ff104d
Create 'Developing apps' in tt docs
andreyaksenov Jul 25, 2024
466009b
Reorder topics in App
andreyaksenov Jul 25, 2024
623878f
Overview - cosmetics
andreyaksenov Jul 25, 2024
7468d71
Move 'Admin' to the top level
andreyaksenov Jul 25, 2024
9176dad
Fix image paths
andreyaksenov Jul 25, 2024
a016052
Connections - Rename files
andreyaksenov Jul 25, 2024
2cce9a0
Add triggers
andreyaksenov Jul 25, 2024
871f9b7
Fix include
andreyaksenov Jul 25, 2024
7fbf986
Drop dev_guide
andreyaksenov Jul 25, 2024
127b1e9
Fix list
andreyaksenov Jul 25, 2024
9f1367c
Move iproto to the corresponding section
andreyaksenov Jul 25, 2024
51c7928
Fix anchor
andreyaksenov Jul 25, 2024
8375b7b
Fix include
andreyaksenov Jul 25, 2024
9163136
Move 'Data model' to index
andreyaksenov Jul 25, 2024
893baef
Remove tarantoolctl mentions from the Admin guide
andreyaksenov Jul 25, 2024
282f9af
Fix 'undefined label'
andreyaksenov Jul 25, 2024
403cb45
Add tarantoolctl - tt migration
andreyaksenov Jul 25, 2024
f229d52
Fix 'unknown document'
andreyaksenov Jul 25, 2024
568c5cb
Reorder Admin section
andreyaksenov Jul 26, 2024
1c23396
Rename 'Feature comparison'
andreyaksenov Jul 26, 2024
70b288f
l11n: move replication
andreyaksenov Jul 29, 2024
226d595
l11n: move Administration
andreyaksenov Jul 29, 2024
1520987
l11n: move Sharding
andreyaksenov Jul 29, 2024
ec0380c
l11n: move Getting started
andreyaksenov Jul 30, 2024
51858cc
l11n: move atomic
andreyaksenov Jul 30, 2024
c800d5e
l11n: move engines
andreyaksenov Jul 30, 2024
17c6f99
l11n: move data model
andreyaksenov Jul 30, 2024
1a858a9
l11n: move triggers
andreyaksenov Jul 30, 2024
2f57269
l11n: move concepts index
andreyaksenov Jul 30, 2024
40e0bca
l11n: move app
andreyaksenov Jul 30, 2024
eec5c91
l11n: move db
andreyaksenov Jul 30, 2024
8953276
l11n: move security
andreyaksenov Jul 30, 2024
60e643f
l11n: move contributing
andreyaksenov Jul 30, 2024
6bc824a
Add missing EE features
andreyaksenov Jul 30, 2024
4ba20fb
Update Overview per review
andreyaksenov Aug 1, 2024
9186519
Update Overview per review 2
andreyaksenov Aug 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,6 @@ locale/*

# tntcxx submodule

/doc/how-to/getting_started_cxx.rst
/doc/how-to/_includes
/doc/book/connectors/cxx/
/doc/getting_started_cxx.rst
/doc/_includes
/doc/connector/cxx/
11 changes: 6 additions & 5 deletions build_submodules.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ mv -fv "${luatest_dest}/index.rst" "${luatest_dest}/_includes/"

# Tarantool C++ connector
tntcxx_root="${project_root}/modules/tntcxx"
tntcxx_howto_dest="${project_root}/doc/how-to"
tntcxx_api_dest="${project_root}/doc/book/connectors"
tntcxx_howto_dest="${project_root}/doc/connector"
tntcxx_api_dest="${project_root}/doc/connector"

# Copy Tarantool C++ connector docs to the right places
mkdir -p "${tntcxx_api_dest}/cxx/"
mkdir -p "${tntcxx_howto_dest}/_includes"
cp -rfv "${tntcxx_root}/doc/tntcxx_getting_started.rst" "${tntcxx_howto_dest}/getting_started_cxx.rst"
cp -rfv "${tntcxx_root}/examples/" "${tntcxx_howto_dest}/_includes/examples/"
mkdir -p "${tntcxx_howto_dest}/cxx/"
mkdir -p "${tntcxx_howto_dest}/cxx/_includes/"
cp -rfv "${tntcxx_root}/doc/tntcxx_getting_started.rst" "${tntcxx_howto_dest}/cxx/"
cp -rfv "${tntcxx_root}/examples/" "${tntcxx_howto_dest}/cxx/_includes/examples/"
cp -rfv "${tntcxx_root}/doc/tntcxx_api.rst" "${tntcxx_api_dest}/cxx/"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
Flight recorder
===============

.. admonition:: Enterprise Edition
:class: fact

The flight recorder is available in the `Enterprise Edition <https://www.tarantool.io/compare/>`_ only.

**Example on GitHub**: `flightrec <https://github.com/tarantool/doc/tree/latest/doc/code_snippets/snippets/config/instances.enabled/flightrec>`_

The flight recorder available in the Enterprise Edition is an event collection tool that
gathers various information about a working Tarantool instance, such as:
The flight recorder is an event collection tool that gathers various information about a working Tarantool instance, such as:

* logs
* metrics
Expand Down Expand Up @@ -49,8 +53,8 @@ Tarantool continues writing to the existing ``current.ttfr`` file after restart.

.. _enterprise-flight-recorder_configure:

Configure a flight recorder
---------------------------
Configure the flight recorder
-----------------------------

When the flight recorder is enabled, you can set the options related to :ref:`logging <cfg_logging-log>`,
:ref:`metrics <metrics-reference>`, and storing the :ref:`request and response <internals-requests_responses>` data.
Expand Down
10 changes: 4 additions & 6 deletions doc/book/admin/index.rst → doc/admin/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,21 @@ utilities:
This chapter includes the following sections:

.. toctree::
:maxdepth: 2
:maxdepth: 1
:numbered: 0

instance_config
start_stop_instance
modules
logs
security
access_control
vshard_admin
replication/index
server_introspection
daemon_supervision
disaster_recovery
backups
upgrades
os_notes
bug_reports
troubleshoot
flight_recorder
monitoring
os_notes
troubleshoot
3 changes: 0 additions & 3 deletions doc/book/admin/logs.rst → doc/admin/logs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ program.
There is also the built-in function :ref:`log.rotate() <log-rotate>`, which you
can call on an instance to reopen its log file after rotation.

To learn about log rotation in the deprecated ``tarantoolctl`` utility,
check its :ref:`documentation <tarantoolctl-log-rotation>`.


.. _admin-logs-destination:

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -847,10 +847,10 @@ Saved tuples are divided into 3 categories: ``used``, ``read_view``, ``tracking`

Each category has two metrics:

- ``retained`` tuples - they are no longer in the index, but MVCC does not allow them to be removed.
- ``stories`` - MVCC is based on the story mechanism, almost every tuple has a story.
This is a separate metric because even the tuples that are in the index can have a story.
So ``stories`` and ``retained`` need to be measured separately.
- ``retained`` tuples - they are no longer in the index, but MVCC does not allow them to be removed.
- ``stories`` - MVCC is based on the story mechanism, almost every tuple has a story.
This is a separate metric because even the tuples that are in the index can have a story.
So ``stories`` and ``retained`` need to be measured separately.

.. container:: table

Expand Down
9 changes: 0 additions & 9 deletions doc/book/admin/os_notes.rst → doc/admin/os_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,3 @@ Checking that it works:

$ /etc/init.d/your_service_name start
$ tail -f -n 100 /var/log/tarantool/your_service_name.log


.. _admin-os_notes-freebsd:

FreeBSD
-------

To learn about specifics of using the deprecated ``tarantoolctl`` utility on FreeBSD,
check its :ref:`documentation <tarantoolctl-freebsd>`.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To learn what instances belong to the replica set and obtain statistics for all
these instances, execute a :ref:`box.info.replication <box_info_replication>` request.
The output below shows the replication status for a replica set containing one :ref:`master and two replicas <replication-master_replica_bootstrap>`:

.. include:: /how-to/replication/repl_bootstrap.rst
.. include:: /platform/replication/replication_tutorials/repl_bootstrap.rst
:start-after: box_info_replication_manual_leader_start
:end-before: box_info_replication_manual_leader_end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ hardware or network failure, or due to a programming bug.

The master's upstream status is reported as ``disconnected`` when executing :ref:`box.info.replication <replication-monitoring>` on a replica:

.. include:: /how-to/replication/repl_bootstrap_auto.rst
.. include:: /platform/replication/replication_tutorials/repl_bootstrap_auto.rst
:start-after: box_info_replication_auto_leader_disconnected_start
:end-before: box_info_replication_auto_leader_disconnected_end

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 4 additions & 6 deletions doc/alternate_build_master.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@

overview_index
getting_started/index
how-to/index
concepts/index
CRUD operations <reference/reference_lua/box_space>
book/admin/index
book/connectors
enterprise/index
platform/index
tooling/index
admin/index
connector/index
reference/index
contributing/index
release/index
Expand Down
21 changes: 0 additions & 21 deletions doc/book/box/index.rst

This file was deleted.

200 changes: 0 additions & 200 deletions doc/book/connectors/go.rst

This file was deleted.

Loading
Loading