Changeset View
Changeset View
Standalone View
Standalone View
docs/README.rst
Show First 20 Lines • Show All 46 Lines • ▼ Show 20 Lines | |||||
- a deposited artifact has a codemeta_ metadata entry attached to it, | - a deposited artifact has a codemeta_ metadata entry attached to it, | ||||
- a deposited artifact has the same visibility on the SWH Archive than a collected | - a deposited artifact has the same visibility on the SWH Archive than a collected | ||||
repository, | repository, | ||||
- a deposited artifact can be searched with its provided url property on the SWH | - a deposited artifact can be searched with its provided url property on the SWH | ||||
Archive, | Archive, | ||||
- the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send deposits | - the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send deposits | ||||
to SWH. These tools are provided with this repository. | to SWH. These tools are provided with this repository. | ||||
See the :ref:`user-manual` page for more details on how to use the deposit client | See the :ref:`deposit-user-manual` page for more details on how to use the deposit client | ||||
command line tools to push a deposit in the SWH Archive. | command line tools to push a deposit in the SWH Archive. | ||||
See the :ref:`swh-api-specifications` reference pages of the SWORDv2 API implementation | See the :ref:`deposit-api-specifications` reference pages of the SWORDv2 API implementation | ||||
in `swh.deposit` if you want to do upload deposits using HTTP requests. | 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 | Read the :ref:`metadata` chapter to get more details on what metadata are supported when | ||||
doing a deposit. | doing a deposit. | ||||
See :ref:`swh-deposit-dev` if you want to hack the code of the `swh.deposit` module. | See :ref:`swh-deposit-dev-env` 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 | See :ref:`swh-deposit-prod-env` if you want to deploy your own copy of the | ||||
`swh.deposit` stack. | `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/ |