Restructure docs, stage 1 (#3054)

* Update and restructure the Releases section
* Remove irrelevant beta and rc release notes
* Remove doubled text on index page
* Add the Overview article, based on Mons Anderson's article on Habr
* Create the new How-to section
* Move 'Getting started/What's next' to the new How-to section
* Add SQL Beginners' Guide to How-to
* Add CRUD operations how-to guide
* Fix links
* Point to the Cartridge tutorial explicitly

Part of #2805
Resolves #2487
Resolves #1467

Co-authored-by: Pavel Semyonov <[email protected]>
Co-authored-by: Evgeniy Osintsev <[email protected]>
Co-authored-by: Kseniia Antonova <[email protected]>
Co-authored-by: Nick Volynkin <[email protected]>

Author: 5 people

.gitignore

@@ -74,6 +74,6 @@ locale/*
 
 # tntcxx submodule
 
-/doc/getting_started/getting_started_cxx.rst
-/doc/getting_started/_includes/
+/doc/how-to/getting_started_cxx.rst
+/doc/how-to/_includes
 /doc/book/connectors/cxx/

build_submodules.sh

@@ -98,12 +98,12 @@ cp -rfv "${cartridge_kubernetes_root}" "${cartridge_kubernetes_dest}"
 
 # Tarantool C++ connector
 tntcxx_root="${project_root}/modules/tntcxx"
-tntcxx_gs_dest="${project_root}/doc/getting_started"
+tntcxx_howto_dest="${project_root}/doc/how-to"
 tntcxx_api_dest="${project_root}/doc/book/connectors"
 
 # Copy Tarantool C++ connector docs to the right places
 mkdir -p "${tntcxx_api_dest}/cxx/"
-mkdir -p "${tntcxx_gs_dest}/_includes"
-cp -rfv "${tntcxx_root}/doc/tntcxx_getting_started.rst" "${tntcxx_gs_dest}/getting_started_cxx.rst"
-cp -rfv "${tntcxx_root}/examples/" "${tntcxx_gs_dest}/_includes/examples/"
+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/"
 cp -rfv "${tntcxx_root}/doc/tntcxx_api.rst" "${tntcxx_api_dest}/cxx/"

conf.py

@@ -21,6 +21,7 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.intersphinx',
     'sphinx.ext.extlinks',
+    'sphinx_panels',
     'sphinxcontrib.plantuml',
     'ext.custom',
     'ext.LuaDomain',

doc/book/intro.rst

@@ -16,7 +16,7 @@ To get started, you can install and launch Tarantool using
 or the online Tarantool server at http://try.tarantool.org.
 Either way, as the first tryout, you can follow the introductory exercises
 from :ref:`Chapter 2 "Getting started" <getting_started>`.
-If you want more hands-on experience, proceed to :ref:`Tutorials <tutorials>`
+If you want more hands-on experience, proceed to :ref:`How-to guides <how-to>`
 after you are through with Chapter 2.
 
 :ref:`Chapter 3 "Database" <database-chapter>` is about using Tarantool

doc/getting_started/index.rst

@@ -37,4 +37,7 @@ to write in/migrate to Tarantool.
    connecting_to_cluster
    change_schema_dynamically
    writing_cluster_code
-   whats_next
+
+To continue exploring Tarantool and its ecosystem, you might want to check out
+Tarantool :doc:`tutorials and guides <../how-to/index>`.
+The :ref:`Cartridge beginner tutorial <getting_started_cartridge>` can also be found there.

doc/getting_started/whats_next.rst

@@ -0,0 +1,8 @@
+Developing applications with Tarantool
+======================================
+
+..  toctree::
+    :maxdepth: 1
+
+    lua_tutorials
+    c_tutorial

doc/tutorials/c_tutorial.rst renamed to doc/how-to/app/c_tutorial.rst

@@ -1,8 +1,7 @@
 .. _box_space_examples:
 
-===============================================================================
-Examples
-===============================================================================
+CRUD operation examples
+=======================
 
 -------------------------------------------------------------------------------
 Example: using box.space functions to read _space tuples