Page MenuHomeSoftware Heritage

docs: Split 'content update' and 'metadata update' in the 'Use cases' docs
ClosedPublic

Authored by vlorentz on Apr 8 2021, 4:23 PM.

Details

Summary

The three update types are already too easy too confuse,
let's not add more confusing by documenting them in the
same subsections.

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

Build is green

Patch application report for D5462 (id=19507)

Could not rebase; Attempt merge onto ab85694f2f...

Updating ab85694f..63ed7fc9
Fast-forward
 docs/api/use-cases.rst                       | 73 ++++++++++++++++++++--------
 docs/api/user-manual.rst                     |  2 +-
 docs/images/deposit-authentication-basic.uml |  2 +-
 docs/images/deposit-create-chart.uml         | 20 +++++---
 docs/images/deposit-delete-chart.uml         | 22 ++++-----
 docs/images/deposit-update-chart.uml         | 27 +++++-----
 docs/internals/authentication.rst            |  4 +-
 7 files changed, 95 insertions(+), 55 deletions(-)
Changes applied before test
commit 63ed7fc9376a783cf3879e0aad26848fbc11162a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 16:22:28 2021 +0200

    docs: Split 'content update' and 'metadata update' in the 'Use cases' docs
    
    The three update types are already too easy too confuse,
    let's not add more confusing by documenting them in the
    same subsections.

commit ae1955ab087e0ddbd2b2889584779ad66b50af58
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 16:21:04 2021 +0200

    docs: Describe deposit loading step in 'Use cases'.

commit 2c47664fef9b8a56108080baaf5b908ffbe02771
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 15:46:30 2021 +0200

    docs: Add a reminder of the status flowchart in 'Use cases'
    
    A reminder never hurts.
    
    Also fixes the image path.

commit 0d54e2e04cb5c5b0209e12c1183dcbe21549ef39
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 15:43:21 2021 +0200

    docs: Fix title hierarchy in 'use case'
    
    Everything was in 'Schema representation'...

commit 3956ee39c32ebbbc3175faa25ea3cfce778ce6b1
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 15:41:53 2021 +0200

    docs: Add task scheduling on the 'use case' charts

commit a65c8b2f7cc8f0957a07e8ec716273b7197d67fe
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Apr 8 15:17:18 2021 +0200

    docs: Replace 'deposit storage' terminology; it's confusing
    
    It has nothing to do with swh-storage.
    
    The terminology also implies it's somehow 'smart', but it only refers
    to the database. (or to the deposit server itself in authentication.rst)

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

This revision is now accepted and ready to land.Apr 8 2021, 4:59 PM
This revision was landed with ongoing or failed builds.Apr 8 2021, 5:04 PM
This revision was automatically updated to reflect the committed changes.

Build is green

Patch application report for D5462 (id=19521)

Rebasing onto f7beed082d...

First, rewinding head to replay your work on top of it...
Fast-forwarded diff-target to base-revision-632-D5462.
Changes applied before test

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