Differential D4428

doc: improve the spec-loading doc
ClosedPublic
Actions

Authored by douardda on Nov 6 2020, 10:58 AM.

Details

Reviewers

vlorentz

Group Reviewers

Reviewers

Commits

rDDEP04c11145081f: doc: improve the spec-loading doc

Summary

update some deprecated statements (tar loader -> deposit loader)
explcit API calls for example JSON snippets
update JSON snippets for current API behavior

Depends on D4427.

Diff Detail

Repository

rDDEP Push deposit

Branch

doc

Lint

Lint Skipped

Unit

Unit Tests Skipped

Build Status

Buildable 16910
Build 26087: Phabricator diff pipeline on jenkins	Jenkins console · Jenkins
Build 26086: arc lint + arc unit

Event Timeline

douardda created this revision.Nov 6 2020, 10:58 AM

Herald added a reviewer: Reviewers. · View Herald TranscriptNov 6 2020, 10:58 AM

douardda added a child revision: D4429: doc: add an introduction paragraph in blueprint.rst.Nov 6 2020, 10:59 AM

Build is green

Patch application report for D4428 (id=15684)

Could not rebase; Attempt merge onto 0f4ec31168...

Updating 0f4ec311..489f1ab7
Fast-forward
 docs/endpoints/collection.rst       | 116 +++++++++++++++++++----------------
 docs/endpoints/content.rst          |  65 +++++++++++++++++++-
 docs/endpoints/service-document.rst |  80 ++++++++++++++----------
 docs/endpoints/status.rst           |  63 ++++++++++---------
 docs/endpoints/update-media.rst     |  16 ++---
 docs/endpoints/update-metadata.rst  |  10 +--
 docs/index.rst                      |   2 +-
 docs/spec-api.rst                   |  29 ++++-----
 docs/specs/{specs.rst => index.rst} |   0
 docs/specs/spec-loading.rst         | 119 ++++++++++++++++++------------------
 10 files changed, 297 insertions(+), 203 deletions(-)
 rename docs/specs/{specs.rst => index.rst} (100%)

Changes applied before test

commit 489f1ab76caa54b50e7523c058b4d5034e66d858
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Nov 6 09:36:29 2020 +0100

    doc: improve the spec-loading doc
    
    - update some deprecated statements (tar loader -> deposit loader)
    - explcit API calls for example JSON snippets
    - update JSON snippets for current API behavior

commit 61653ddfc7c38bd4130374a6b6472f55f358138a
Author: David Douard <david.douard@sdfa3.org>
Date:   Thu Nov 5 16:16:07 2020 +0100

    doc: improve the doc of API endpoints
    
    make usage of the sphinx-httpdomain extension according to its
    documenation.

commit 1736371f2c6da9713e4f815da99cd3cd624fdaad
Author: David Douard <david.douard@sdfa3.org>
Date:   Thu Nov 5 14:21:40 2020 +0100

    doc: rename docs/specs/specs.rst as docs/specs/index.rst
    
    for the sake of clarity.

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/282/ for more details.

Harbormaster completed remote builds in B16898: Diff 15684.Nov 6 2020, 11:06 AM

vlorentz added a subscriber: vlorentz.Nov 6 2020, 11:26 AM

vlorentz added inline comments.

docs/specs/spec-loading.rst
68	this one too, for consistency
90	could we keep this block as json, and move the shell command out of the block?
124–132	same

douardda added inline comments.Nov 6 2020, 11:27 AM

docs/specs/spec-loading.rst
90	why not, let me do that

split code blocks in 2 as requested by vlorentz

thx!

This revision is now accepted and ready to land.Nov 6 2020, 11:33 AM

Build is green

Patch application report for D4428 (id=15696)

Rebasing onto 61653ddfc7...

Current branch diff-target is up to date.

Changes applied before test

commit 04c11145081fcc22d482665944a6a773f44306c7
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Nov 6 09:36:29 2020 +0100

    doc: improve the spec-loading doc
    
    - update some deprecated statements (tar loader -> deposit loader)
    - explcit API calls for example JSON snippets
    - update JSON snippets for current API behavior

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/288/ for more details.

Harbormaster completed remote builds in B16910: Diff 15696.Nov 6 2020, 11:35 AM

Closed by commit rDDEP04c11145081f: doc: improve the spec-loading doc (authored by douardda). · Explain WhyNov 6 2020, 11:36 AM

This revision was automatically updated to reflect the committed changes.

douardda added a commit: rDDEP04c11145081f: doc: improve the spec-loading doc.

Reviewed even if already closed.
The changes are good.
Thanks David for this diff. it can partly address T2391.