Paths

Table of Contentst

Differential D4971

Write introduction to swh-storage.
ClosedPublic
Actions

Authored by vlorentz on Jan 29 2021, 4:18 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3004: swh-storage documentation needs a better introduction

Commits

rDSTOf6ae8a062d97: Write introduction to swh-storage.

Summary

Explains:

when to use swh-web instead
that get_storage should always be used to instantiate the storage
StorageInterface
model objects
pagination
backends

Resolves T3004.

Diff Detail

Repository

rDSTO Storage manager

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz created this revision.Jan 29 2021, 4:18 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptJan 29 2021, 4:18 PM

Build is green

Patch application report for D4971 (id=17752)

Rebasing onto 76de53cb26...

Current branch diff-target is up to date.

Changes applied before test

commit fcaa8d6bdcf970e8a4a8316413266d37792c297b
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Fri Jan 29 16:17:51 2021 +0100

    Write introduction to swh-scheduler.
    
    Explains:
    
    * when to use swh-web instead
    * that `get_storage` should always be used to instantiate the storage
    * `StorageInterface`
    * model objects
    * pagination
    * backends

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

Harbormaster completed remote builds in B18893: Diff 17752.Jan 29 2021, 4:23 PM

vlorentz requested review of this revision.Jan 29 2021, 4:23 PM

fix commit msg

vlorentz retitled this revision from Write introduction to swh-scheduler. to Write introduction to swh-storage..Jan 29 2021, 4:28 PM

Build is green

Patch application report for D4971 (id=17753)

Rebasing onto 76de53cb26...

Current branch diff-target is up to date.

Changes applied before test

commit 24a7b88c2e8461c209f6bf15b3635bd07790994a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Fri Jan 29 16:17:51 2021 +0100

    Write introduction to swh-storage.
    
    Explains:
    
    * when to use swh-web instead
    * that `get_storage` should always be used to instantiate the storage
    * `StorageInterface`
    * model objects
    * pagination
    * backends

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

Harbormaster completed remote builds in B18894: Diff 17753.Jan 29 2021, 4:33 PM

lgtm

one remark inline.

docs/index.rst
30	strike usually? It is instantiated through the `get_storage` factory.

This revision is now accepted and ready to land.Jan 29 2021, 5:59 PM

remove 'usually'

This revision was landed with ongoing or failed builds.Feb 1 2021, 12:03 PM

Closed by commit rDSTOf6ae8a062d97: Write introduction to swh-storage. (authored by vlorentz). · Explain Why

This revision was automatically updated to reflect the committed changes.

vlorentz added a commit: rDSTOf6ae8a062d97: Write introduction to swh-storage..

Build is green

Patch application report for D4971 (id=17769)

Rebasing onto 76de53cb26...

Current branch diff-target is up to date.

Changes applied before test

commit f6ae8a062d97e6d6154d3da25ab99e6ff7c8e4db
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Fri Jan 29 16:17:51 2021 +0100

    Write introduction to swh-storage.
    
    Explains:
    
    * when to use swh-web instead
    * that `get_storage` should always be used to instantiate the storage
    * `StorageInterface`
    * model objects
    * pagination
    * backends

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

Harbormaster completed remote builds in B18910: Diff 17769.Feb 1 2021, 12:08 PM