diff --git a/docs/dev-info.rst b/docs/dev-info.rst --- a/docs/dev-info.rst +++ b/docs/dev-info.rst @@ -1,3 +1,5 @@ +.. _swh-deposit-dev: + Hacking on swh-deposit ====================== diff --git a/docs/endpoints/collection.rst b/docs/endpoints/collection.rst --- a/docs/endpoints/collection.rst +++ b/docs/endpoints/collection.rst @@ -1,4 +1,5 @@ .. _API-create-deposit: + Create deposit ^^^^^^^^^^^^^^^ diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ Software Heritage - Deposit =========================== -Push-based deposit of software source code artifacts and metadata to the +`SWORD v2`_ based deposit of software source code artifacts and metadata to the Software Heritage (SWH) Archive. Description @@ -54,7 +54,21 @@ See the :ref:`user-manual` page for more details on how to use the deposit -client tools to push a deposit in the SWH Archive. +client command line tools to push a deposit in the SWH Archive. + +See the :ref:`swh-api-specifications` reference pages of the SWORDv2 API +implementation in `swh.deposit` if you want to do upload deposits using HTTP +requests. + +Read the :ref:`metadata` chapter to get more details on what metadata are +supported when doing a deposit. + +See :ref:`swh-deposit-dev` if you want to hack the code of the `swh.deposit` +module. + +See :ref:`swh-deposit-deployment` if you want to deploy your own copy of the +`swh.deposit` stack. + .. _codemeta: https://codemeta.github.io/ .. _`SWORD v2`: http://swordapp.org/sword-v2/ @@ -64,8 +78,8 @@ :caption: Contents: user-manual - spec-api metadata + spec-api dev-info sys-info specs/index diff --git a/docs/spec-api.rst b/docs/spec-api.rst --- a/docs/spec-api.rst +++ b/docs/spec-api.rst @@ -1,4 +1,6 @@ -API Specification +.. _swh-api-specifications: + +API Documentation ================= This is `Software Heritage `__'s diff --git a/docs/sys-info.rst b/docs/sys-info.rst --- a/docs/sys-info.rst +++ b/docs/sys-info.rst @@ -1,3 +1,5 @@ +.. _swh-deposit-deployment: + Deployment of the swh-deposit ============================= @@ -90,6 +92,3 @@ checks which are fine) and removes the different archives' identifiers (swh-id, ...) - trigger back the loading task through the scheduler - - -