Skip to content
Snippets Groups Projects
Commit d7d01c29 authored by Renaud Boyer's avatar Renaud Boyer
Browse files

fix sphinx tabs

parent e8eca019
No related branches found
No related tags found
No related merge requests found
......@@ -5,7 +5,7 @@ Requisites
----------
1. Have your account credentials and prepared artefacts at hand.
2. Either the CLI installed or a tool to make API calls (curl_, HTTPie_, etc.)
2. Either the CLI installed or a tool to make API calls (curl, HTTPie, etc.)
Make a code deposit
-------------------
......@@ -13,40 +13,48 @@ Make a code deposit
One shot
^^^^^^^^
.. tabs::
.. code-tab:: CLI
.. tab-set::
.. tab-item:: CLI
.. code-block:: console
swh deposit ...
.. code-tab:: API
.. tab-item:: API
.. code-block:: console
# Note the 'In-Progress: false' header
curl -i -u <username>:<pass> \
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
Partial
^^^^^^^
Check its status
----------------
Your deposit will go :doc:`through multiple steps </references/workflow>` before appearing in the archive, You can check the status of your deposit ang get its SWHID :
.. tabs::
.. tab-set::
.. code-tab:: CLI
swh deposit status ...
.. tab-item:: CLI
.. code-tab:: API
.. code-block:: console
swh deposit ...
curl -i -u hal:<pass> \
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
.. tab-item:: API
.. code-block:: console
:: _curl: https://curl.se/
:: _HTTPie: https://httpie.io/
\ No newline at end of file
curl -i -u hal:<pass> \
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
Make a metadata-only deposit
===================
============================
Requisites
----------
1. Have your account credentials, the origin url and prepared artefacts at hand.
2. Either the CLI installed or a tool to make API calls (curl_, HTTPie_, etc.)
2. Either the CLI installed or a tool to make API calls (curl, HTTPie, etc.)
Make a metadata deposit
-------------------
-----------------------
.. tab-set::
.. tab-item:: CLI
.. code-block:: console
.. tabs::
.. code-tab:: CLI
swh deposit ...
.. code-tab:: API
.. tab-item:: API
.. code-block:: console
# Note the 'In-Progress: false' header
curl -i -u <username>:<pass> \
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
Check its status
......@@ -27,19 +35,21 @@ Check its status
Your deposit will go :doc:`through multiple steps </references/workflow>` before appearing in the archive, You can check the status of your deposit ang get its SWHID :
.. tabs::
.. tab-set::
.. tab-item:: CLI
.. code-tab:: CLI
swh deposit status ...
.. code-block:: console
swh deposit ...
.. code-tab:: API
.. tab-item:: API
curl -i -u hal:<pass> \
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
.. code-block:: console
curl -i -u hal:<pass> \
-F "file=@deposit.json;type=application/zip;filename=payload" \
-F "atom=@atom-entry.xml;type=application/atom+xml;charset=UTF-8" \
-H 'In-Progress: false' \
-XPOST https://deposit.softwareheritage.org/1/hal/
:: _curl: https://curl.se/
:: _HTTPie: https://httpie.io/
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment