diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -30,7 +30,6 @@ * :ref:`mirror` → learn what a Software Heritage mirror is and how to set up one - Data Model and Specifications ----------------------------- @@ -38,6 +37,12 @@ * :ref:`data-model` Documentation of the main |swh| archive data model. * :ref:`journal-specs` Documentation of the Kafka journal of the |swh| archive. +Tutorials +--------- + +* :ref:`testing-guide` +* :doc:`/tutorials/issue-debugging-monitoring` + Components ---------- @@ -170,6 +175,7 @@ getting-started developer-setup contributing/index + tutorials/index API documentation swh.core swh.dataset @@ -189,5 +195,3 @@ swh.vault swh.web swh.web.client - testing - issue-debugging-monitoring diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst new file mode 100644 --- /dev/null +++ b/docs/tutorials/index.rst @@ -0,0 +1,13 @@ +Tutorials +========= + +.. keep this in sync with the 'Tutorials' section in swh-docs/docs/index.rst + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :titlesonly: + :hidden: + + testing + issue-debugging-monitoring diff --git a/docs/issue-debugging-monitoring.md b/docs/tutorials/issue-debugging-monitoring.md rename from docs/issue-debugging-monitoring.md rename to docs/tutorials/issue-debugging-monitoring.md diff --git a/docs/testing.rst b/docs/tutorials/testing.rst rename from docs/testing.rst rename to docs/tutorials/testing.rst --- a/docs/testing.rst +++ b/docs/tutorials/testing.rst @@ -1,3 +1,4 @@ +.. _testing-guide: Software testing guide ======================