diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -52,7 +52,8 @@ - the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send deposits to SWH. These tools are provided with this repository. -See the :ref:`getting-started` 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. .. _codemeta: https://codemeta.github.io/ @@ -62,7 +63,7 @@ :maxdepth: 2 :caption: Contents: - getting-started + user-manual spec-api metadata dev-info diff --git a/docs/getting-started.rst b/docs/user-manual.rst rename from docs/getting-started.rst rename to docs/user-manual.rst --- a/docs/getting-started.rst +++ b/docs/user-manual.rst @@ -1,31 +1,26 @@ -Getting Started -=============== +User Manual +=========== This is a guide for how to prepare and push a software deposit with the `swh deposit` commands. -The API is rooted at https://deposit.softwareheritage.org/1. - -For more details, see the `main documentation <./index.html>`__. Requirements ------------ -You need to be referenced on SWH's client list to have: - -* credentials (needed for the basic authentication step) - - - in this document we reference ```` as the client's name and - ```` as its associated authentication password. - -* an associated collection_. +You need to have an account on the Software Heritage deposit application to be +able to use the service. +Please `contact the Software Heritage team `_ for +more information on how to get access to this service. -.. _collection: https://bitworking.org/projects/atom/rfc5023#rfc.section.8.3.3 +For testing purpose, a test instance `is available +`_ [#f1]_ and will be used in the examples below. +Once you have an account, you should get a set of access credentials as a +`login` and a `password` (identified as ```` and ```` in the +remaining of this document.) -`Contact us for more information. -`__ Prepare a deposit ----------------- @@ -283,3 +278,10 @@ 'deposit_status_detail': 'The deposit has been successfully \ loaded into the Software Heritage archive' } + + + +.. rubric:: Footnotes + +.. [#f1] the test instance of the deposit is not yet available external users, + but it should be available soon.