Changeset View
Changeset View
Standalone View
Standalone View
docs/index.rst
Show All 24 Lines | |||||
Architecture | Architecture | ||||
------------ | ------------ | ||||
* :ref:`architecture` → get a glimpse of the Software Heritage software | * :ref:`architecture` → get a glimpse of the Software Heritage software | ||||
architecture | architecture | ||||
* :ref:`mirror` → learn what a Software Heritage mirror is and how to set up | * :ref:`mirror` → learn what a Software Heritage mirror is and how to set up | ||||
one | one | ||||
Data Model and Specifications | Data Model and Specifications | ||||
----------------------------- | ----------------------------- | ||||
* :ref:`persistent-identifiers` Specifications of the SoftWare Heritage persistent IDentifiers (SWHID). | * :ref:`persistent-identifiers` Specifications of the SoftWare Heritage persistent IDentifiers (SWHID). | ||||
* :ref:`data-model` Documentation of the main |swh| archive data model. | * :ref:`data-model` Documentation of the main |swh| archive data model. | ||||
* :ref:`journal-specs` Documentation of the Kafka journal of the |swh| archive. | * :ref:`journal-specs` Documentation of the Kafka journal of the |swh| archive. | ||||
Tutorials | |||||
--------- | |||||
* :ref:`testing-guide` | |||||
* :doc:`/tutorials/issue-debugging-monitoring` | |||||
Components | Components | ||||
---------- | ---------- | ||||
Here is brief overview of the most relevant software components in the Software | Here is brief overview of the most relevant software components in the Software | ||||
Heritage stack. Each component name is linked to the development documentation | Heritage stack. Each component name is linked to the development documentation | ||||
of the corresponding Python module. | of the corresponding Python module. | ||||
:ref:`swh.core <swh-core>` | :ref:`swh.core <swh-core>` | ||||
▲ Show 20 Lines • Show All 116 Lines • ▼ Show 20 Lines | .. toctree:: | ||||
:caption: Contents: | :caption: Contents: | ||||
:titlesonly: | :titlesonly: | ||||
:hidden: | :hidden: | ||||
architecture | architecture | ||||
getting-started | getting-started | ||||
developer-setup | developer-setup | ||||
contributing/index | contributing/index | ||||
tutorials/index | |||||
API documentation <apidoc/modules> | API documentation <apidoc/modules> | ||||
swh.core <swh-core/index> | swh.core <swh-core/index> | ||||
swh.dataset <swh-dataset/index> | swh.dataset <swh-dataset/index> | ||||
swh.deposit <swh-deposit/index> | swh.deposit <swh-deposit/index> | ||||
swh.fuse <swh-fuse/index> | swh.fuse <swh-fuse/index> | ||||
swh.graph <swh-graph/index> | swh.graph <swh-graph/index> | ||||
swh.indexer <swh-indexer/index> | swh.indexer <swh-indexer/index> | ||||
swh.journal <swh-journal/index> | swh.journal <swh-journal/index> | ||||
swh.lister <swh-lister/index> | swh.lister <swh-lister/index> | ||||
swh.loader <swh-loader> | swh.loader <swh-loader> | ||||
swh.model <swh-model/index> | swh.model <swh-model/index> | ||||
swh.objstorage <swh-objstorage/index> | swh.objstorage <swh-objstorage/index> | ||||
swh.scanner <swh-scanner/index> | swh.scanner <swh-scanner/index> | ||||
swh.scheduler <swh-scheduler/index> | swh.scheduler <swh-scheduler/index> | ||||
swh.search <swh-search/index> | swh.search <swh-search/index> | ||||
swh.storage <swh-storage/index> | swh.storage <swh-storage/index> | ||||
swh.vault <swh-vault/index> | swh.vault <swh-vault/index> | ||||
swh.web <swh-web/index> | swh.web <swh-web/index> | ||||
swh.web.client <swh-web-client/index> | swh.web.client <swh-web-client/index> | ||||
testing | |||||
issue-debugging-monitoring |