aiming at giving some high-level explanations on what the deposit is.
Details
Details
- Reviewers
ardumont moranegg - Group Reviewers
Reviewers - Commits
- rDDEP605bfda59483: Add a description of the deposit in the docs' index page
Diff Detail
Diff Detail
- Repository
- rDDEP Push deposit
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
Event Timeline
Comment Actions
Build is green
Patch application report for D4358 (id=15411)
Rebasing onto 021236dcbb...
Current branch diff-target is up to date.
Changes applied before test
commit 5d34578fc7a9402d8bb0523ad10430a977255511
Author: David Douard <david.douard@sdfa3.org>
Date: Tue Oct 27 10:46:34 2020 +0100
Add a description of the deposit in the docs' index page
aiming at giving some high-level explanations on what the deposit is.See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/267/ for more details.
Comment Actions
Build is green
Patch application report for D4358 (id=15421)
Rebasing onto 021236dcbb...
Current branch diff-target is up to date.
Changes applied before test
commit 18254fe6c8cd3932400e734160e5202018601de9
Author: David Douard <david.douard@sdfa3.org>
Date: Tue Oct 27 10:46:34 2020 +0100
Add a description of the deposit in the docs' index page
aiming at giving some high-level explanations on what the deposit is.See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/268/ for more details.
Comment Actions
Very nice introduction.
I made a few comments for accuracy.
Also, I think you can introduce the acronym SWH and then use it everywhere on the page.
| docs/index.rst | ||
|---|---|---|
| 6–7 | and metadata | |
| 21 | Alternatively, Software Heritage allows its partners to push source code artifacts and metadata | |
| 31 | cite => reference At this time, SWH alone can't be used for citation because we can't give credit. | |
| 37 | This is very important! I haven't had the time to truly capture these differences and it is good to have it here. I will propose a couple of modifications to be more accurate. | |
| 46 | Was: - a deposited artifact have codemeta_ metadata attached to it, - a deposited artifact is linked to the deposit user with (some) trust, - a deposit requires a metadata file describing the deposited artifact, - the deposit API uses the `SWORD v2`_ API, thus requires some tooling to make the deposit (which is provided with this repository). Change to: - a deposited artifact is provided from one of the SWH partners which is regarded as a trusted authority, - a deposited artifact requires metadata properties describing the source code artifact, - 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 repository, - a deposited artifacts can be searched with its provided url property on the SWH Archive, - the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send deposits to SWH. These tools are provided with this repository. | |
| docs/index.rst | ||
|---|---|---|
| 31 | so should I get rid of this paragraph for now? | |
Comment Actions
Build is green
Patch application report for D4358 (id=15426)
Rebasing onto 021236dcbb...
Current branch diff-target is up to date.
Changes applied before test
commit b6df83bfd0cba5aafd6e43abf59e5ac2bb3e9fe6
Author: David Douard <david.douard@sdfa3.org>
Date: Tue Oct 27 10:46:34 2020 +0100
Add a description of the deposit in the docs' index page
aiming at giving some high-level explanations on what the deposit is.See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/270/ for more details.
Comment Actions
Looks good.
missing the SWH acronym that is used in the page, I have added an inline comment for that.
| docs/index.rst | ||
|---|---|---|
| 6 | add here the acronym SWH. | |
Comment Actions
Build is green
Patch application report for D4358 (id=15455)
Rebasing onto 3b8f33876f...
First, rewinding head to replay your work on top of it... Applying: Add a description of the deposit in the docs' index page
Changes applied before test
commit 458817d1ac6262e48703f6639e83eed46c8f2e52
Author: David Douard <david.douard@sdfa3.org>
Date: Tue Oct 27 10:46:34 2020 +0100
Add a description of the deposit in the docs' index page
aiming at giving some high-level explanations on what the deposit is.See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/271/ for more details.
Comment Actions
Build is green
Patch application report for D4358 (id=15463)
Rebasing onto 3b8f33876f...
Current branch diff-target is up to date.
Changes applied before test
commit 605bfda59483d8f4ebbff08a1e65ca81fb1c80b8
Author: David Douard <david.douard@sdfa3.org>
Date: Tue Oct 27 10:46:34 2020 +0100
Add a description of the deposit in the docs' index page
aiming at giving some high-level explanations on what the deposit is.See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/272/ for more details.