Changeset View
Changeset View
Standalone View
Standalone View
docs/index.rst
.. _swh-deposit: | .. _swh-deposit: | ||||
Software Heritage - Deposit | 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. | Software Heritage (SWH) Archive. | ||||
Description | Description | ||||
----------- | ----------- | ||||
Most of the software source code artifacts present in the SWH Archive are | Most of the software source code artifacts present in the SWH Archive are | ||||
gathered by the mean of :term:`loader <loader>` workers run by the SWH project | gathered by the mean of :term:`loader <loader>` workers run by the SWH project | ||||
from sourve code origins identified by :term:`lister <lister>` workers. This is | from sourve code origins identified by :term:`lister <lister>` workers. This is | ||||
Show All 34 Lines | - a deposited artifact has the same visibility on the SWH Archive than a | ||||
collected repository, | collected repository, | ||||
- a deposited artifacts can be searched with its provided url property on the | - a deposited artifacts can be searched with its provided url property on the | ||||
SWH Archive, | SWH Archive, | ||||
- the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send | - the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send | ||||
deposits to SWH. These tools are provided with this repository. | deposits to SWH. These tools are provided with this repository. | ||||
See the :ref:`user-manual` page for more details on how to use the deposit | 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. | |||||
vlorentz: s/you r/your/ | |||||
See :ref:`swh-deposit-deployment` if you want to deploy your own copy of the | |||||
`swh.deposit` stack. | |||||
.. _codemeta: https://codemeta.github.io/ | .. _codemeta: https://codemeta.github.io/ | ||||
.. _`SWORD v2`: http://swordapp.org/sword-v2/ | .. _`SWORD v2`: http://swordapp.org/sword-v2/ | ||||
.. toctree:: | .. toctree:: | ||||
:maxdepth: 2 | :maxdepth: 2 | ||||
:caption: Contents: | :caption: Contents: | ||||
user-manual | user-manual | ||||
spec-api | |||||
metadata | metadata | ||||
spec-api | |||||
dev-info | dev-info | ||||
sys-info | sys-info | ||||
specs/index | specs/index | ||||
tests/tests_HAL.rst | tests/tests_HAL.rst | ||||
Reference Documentation | Reference Documentation | ||||
----------------------- | ----------------------- | ||||
.. toctree:: | .. toctree:: | ||||
:maxdepth: 2 | :maxdepth: 2 | ||||
/apidoc/swh.deposit | /apidoc/swh.deposit |
s/you r/your/