Update user documentation of deposit
Closed, MigratedEdits Locked
Actions

Assigned To

Authored By

	moranegg
	Oct 28 2020, 3:24 PM

Description

@douardda

I made a first deposit with no MD file, just a few options to the cli command (--author, --name and --slug)
then I made a second deposit of the same zip file but with a metadata file (and no options)
and I'm surprised by a few things:

the origin in the web app is https://softwareheritage.org/belenios-01234065 (belenios-0123456 being the slug I gave)

there is only one visit and revision

the second deposit I made (with the metadata file) is not visible in the webapp (either as a visit nor another origin)
nonetheless the deposit has been accepted (status: deposited)

I cannot see where I can find the metadata in the webapp (neither in the revision nor the directory view)

(using a deposit instance in a freshly create docker dev stack)
(you can try my webapp on http://192.168.101.170:5080 from the vpn)

Related Objects

Mentioned In: T2757: the Slug header should not be mandatory
Mentioned Here: T2344: Build a connector for software deposit via Zenodo/InvenioRDM
T2391: Document `--create-origin` on the swh-deposit client for origin creation
T2752: Update the usage of --slug or external_identifier in the deposit cli
T2753: Fix resolution of URLs that were generated for deposits when SWH is the client

Event Timeline

moranegg triaged this task as Normal priority.Oct 28 2020, 3:24 PM

moranegg created this task.

@douardda I saw you had more questions on IRC, can you put them here and I'll capture in comments the answers.
Also I'll open tasks that we identified during our discussion.

Here are the comments I have listed from our discussion last Thursday and I have opened and referenced related tasks :

Use external_id from the metadata file if exists (even without the --slug flag) -> not sure this is feasible technically (T2752)

More information about the slug can be found here: T2391

The URL we generate with a UUID (for the SWH client should be resolvable- to the same artifact that is archived) the origin creation should be more explicit on the documentation since it should be resolvable in the Web App
- For example:

https://archive.softwareheritage.org/swh:1:dir:ef04a768181417fbc5eef4243e2507915f24deea;origin=https://www.softwareheritage.org/check-deposit-2020-02-13T23:15:40.285631;visit=swh:1:snp:6665d47a4d2a19c6e01ddeaf0227e23cb393d2a3;anchor=swh:1:rev:c6a9c5c856e8ea9daffb588c091f9a3876ba3cc3/
see T2753

The "real" Author and Committer of deposits are only in metadata and not on the revision:
- change the author and committer of the deposit to the deposit client (e.g HAL, IPOL, etc.) [Task TBD]
- retro change of existing deposit by creating new revisions ? [Task TBD]

Provide the possibility to generate xml that is SWH SWORD compliant on the CodeMeta generator [Task TBD]

Verify the advantages of implementing SWORD v3 [discussion on T2344]
- it might be a better option to have SWORD v3 in SWH, instead of having a connector done by external partners ?