Differential D8669

Update user documentation for listers and loaders
ClosedPublic
Actions

Authored by anlambert on Oct 12 2022, 5:11 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3117: Publish status of existing listers and loaders

Commits

rDDOC14a934fd06df: user/listers,loaders: Remove links to apidocs
rDDOC25e2498c265f: user/loaders: Add new loaders and update some links and statuses
rDDOC2b88e3344edf: user/listers: Add conda lister and update some links and statuses

Summary

Update statuses of some listers and loaders that moved to staging
Add links to source code of listers/loaders recently landed
Add new listers and loaders in development (conda, cpan, puppet, rubygems)
Remove apidoc links as those are not really useful for a user documentation

Related to T3117

Diff Detail

Repository

rDDOC Development documentation

Lint

Automatic diff as part of commit; lint not applicable.

Unit

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

Event Timeline

anlambert created this revision.Oct 12 2022, 5:11 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptOct 12 2022, 5:11 PM

Fix hackage lister links ordering

Build is green

Patch application report for D8669 (id=31308)

Rebasing onto 99ddc2d8f6...

Current branch diff-target is up to date.

Changes applied before test

commit 74347cf986e31969c7d48bbdf0157d851a23b9dd
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Oct 12 17:07:28 2022 +0200

    user/listers,loaders: Remove links to apidocs
    
    Those are not really useful as links to source codes are already
    present and are out of scope for a user documentation.

commit 5e0c1a1a2ddad20e862c4d0c072e863b50c882d7
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Oct 12 16:54:09 2022 +0200

    user/loaders: Add new loaders and update some links and statuses
    
    Related to T3117

commit 484608d1017fb8650f2db8ec74430f20d1b160bb
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Oct 12 16:53:27 2022 +0200

    user/listers: Add conda lister and update some links and statuses
    
    Related to T3117

See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/243/ for more details.

Harbormaster completed remote builds in B32261: Diff 31308.Oct 12 2022, 5:25 PM

Build is green

Patch application report for D8669 (id=31309)

Rebasing onto 99ddc2d8f6...

Current branch diff-target is up to date.

Changes applied before test

commit 14a934fd06df6038279d9df157bfcc96abff0f55
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Oct 12 17:07:28 2022 +0200

    user/listers,loaders: Remove links to apidocs
    
    Those are not really useful as links to source codes are already
    present and are out of scope for a user documentation.

commit 25e2498c265f07933854f22513c7267649be84a7
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Oct 12 16:54:09 2022 +0200

    user/loaders: Add new loaders and update some links and statuses
    
    Related to T3117

commit 2b88e3344edfff073f0ee948acb356a59040650e
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Oct 12 16:53:27 2022 +0200

    user/listers: Add conda lister and update some links and statuses
    
    Related to T3117

See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/244/ for more details.

Harbormaster completed remote builds in B32262: Diff 31309.Oct 12 2022, 5:28 PM

anlambert requested review of this revision.Oct 12 2022, 5:28 PM

apidoc links are sometimes useful. eg. https://docs.softwareheritage.org/devel/apidoc/swh.lister.crates.html documents the lister's design

ardumont accepted this revision.Oct 18 2022, 10:18 AM

ardumont added a subscriber: ardumont.

ardumont added inline comments.

user/listers/index.rst
390	extra line?

This revision is now accepted and ready to land.Oct 18 2022, 10:18 AM

In D8669#225737, @vlorentz wrote:

apidoc links are sometimes useful. eg. https://docs.softwareheritage.org/devel/apidoc/swh.lister.crates.html documents the lister's design

Yes but most of them (apidocs) are not really of interest. I intend to detail each lister/loader in a separate page later so I think I will move the design doc in it.