docs: Update specs for the sparse-deposit and meta-deposit
Details
- Reviewers
ardumont - Commits
- rDDEP285a8ab37cd0: Update sparse/metadata deposit specs
rDDEPb822bfb13cb3: docs: Add swh xml schema for sparse and meta deposits
rDDEP912420612f3d: Update sparse-deposit and metadata-deposit specs
rDDEP5f99d69285ad: docs: update example meta-deposit
rDDEPf96c11ce3c23: docs: Update specs for the sparse-deposit and meta-deposit
Diff Detail
- Repository
- rDDEP Push deposit
- Branch
- specs
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 1273 Build 1617: arc lint + arc unit
Event Timeline
- 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
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. | |
84 | I seem to recall otherwise. As this does add some unnecessary checks... | |
88 | Each failing check... | |
101 | swh-id? Also, make smaller line, it's more readable ;) |
docs/specs/spec-meta-deposit.rst | ||
---|---|---|
98 | I just learned something new ! | |
docs/specs/spec-sparse-deposit.rst | ||
14 | you are right ! I only updated the examples and ignored the changes we did with the specs. |
docs/specs/spec-meta-deposit.rst | ||
---|---|---|
98 | Awesome ;) |
- 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