Page MenuHomeSoftware Heritage

Create specs for sparse-deposit and metadata-deposit
ClosedPublic

Authored by moranegg on May 7 2018, 4:54 PM.

Diff Detail

Repository
rDDEP Push deposit
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 1230
Build 1574: arc lint + arc unit

Event Timeline

moranegg retitled this revision from Create history page to monitor deposits on web entry point to Create specs for sparse-deposit and meta-deposit.May 7 2018, 4:56 PM
  • docss: Add swh xml schema for sparse and meta deposits
  • docs: update example meta-deposit
  • docs: Update specs for the sparse-deposit and meta-deposit
  • docs: Add swh xml schema for sparse and meta deposits
  • docs: update example meta-deposit

That's a way more readable diff, awesome ;)

  • Update sparse-deposit and metadata-deposit specs
moranegg retitled this revision from Create specs for sparse-deposit and meta-deposit to Create specs for sparse-deposit and metadata-deposit.Jun 18 2018, 4:54 PM
ardumont requested changes to this revision.EditedJun 19 2018, 1:56 PM

Hello, nice.

I propose some small refactoring based mostly around splitting sentences in shorter ones.
And not using contraction when possible (e.g. won't becomes will not and so on...)

As that was some time ago, i'm no longer sure. Still, i recall settling on no longer checking for empty paths in the tarball as this is:

  • one less step for the user to do
  • one less check for us to do

So, everybody wins if we do not do that check.

Cheers,

docs/specs/spec-meta-deposit.rst
10

pushed/provided?

14

... sparse-deposit. While a ...

92

Maybe condense the sample?

With ${type} in {snp (snapshot), rev (revision), rel (release) }:

.. code:: xml
	​
	​  <swh:deposit>
	​    <swh:reference>
	​      <swh:object id="swh:1:${type}:aaaaa............"/>
	​    </swh:reference>
	​  </swh:deposit>

or something?

98
revision_metadata, etc...). Contrary to the complete and sparse deposit, there will be no object creation.

will not is better than won't. As far as i remember, contraction is ok to speak orally but in writings, it's better not to use it.

docs/specs/spec-sparse-deposit.rst
11

the missing directories/contents paths must be...

12
in the tarball. The list linking...
13

That list will be refer`r`ed

14

I'm confused.
I thought we said we did not integrate empty paths in the tarball anymore...
I might be misremembering though ;)

84

I seem to recall otherwise. As this does add some unnecessary checks...
(cf. prior comment around line 14)

88

Each failing check...

101

swh-id?

Also, make smaller line, it's more readable ;)
You can split that sentence at the ,. And starts a new one with That's why...

This revision now requires changes to proceed.Jun 19 2018, 1:56 PM
moranegg added inline comments.
docs/specs/spec-meta-deposit.rst
98

I just learned something new !
I must admit, I did not think you were correct, but before protesting, I searched for it and the Cambridge dictionary says so...
Thank you for this..

docs/specs/spec-sparse-deposit.rst
14

you are right ! I only updated the examples and ignored the changes we did with the specs.
Paths are only in the metadata and not in the tarball!

moranegg marked 2 inline comments as done.
  • Update sparse/metadata deposit specs
ardumont added inline comments.
docs/specs/spec-meta-deposit.rst
98

Awesome ;)

This revision is now accepted and ready to land.Jul 17 2018, 5:48 PM
  • docs: Update specs for the sparse-deposit and meta-deposit
  • docs: Add swh xml schema for sparse and meta deposits
  • docs: update example meta-deposit
  • Update sparse-deposit and metadata-deposit specs
  • Update sparse/metadata deposit specs
This revision was automatically updated to reflect the committed changes.