Page MenuHomeSoftware Heritage

user: Bootstrap loaders high-level documentation
ClosedPublic

Authored by anlambert on Apr 22 2022, 6:10 PM.

Details

Summary

Add landing page of loaders high-level documentation displaying
available ones in a table with the following column:

  • logo and name of the loader linking to its specific documentation
  • related links: source code, developer doc, development activity
  • current status: production, staging or development
  • link to related grant if any

Create one rst file per loader to further document.

Related to T3117

Diff Detail

Repository
rDDOC Development documentation
Branch
loaders-documentation
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 29398
Build 45941: Phabricator diff pipeline on Jenkins for swh-docsJenkins console · Jenkins
Build 45940: arc lint + arc unit

Event Timeline

Build is green

Patch application report for D7637 (id=27651)

Rebasing onto b90babd909...

Current branch diff-target is up to date.
Changes applied before test
commit ffddf88ba44b2de12bd7efca16c462e650d8d1da
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Apr 20 16:22:18 2022 +0200

    user: Bootstrap loaders high-level documentation
    
    Add landing page of loaders high-level documentation displaying
    logos in a grid and linking to each loader documentation page.
    
    Create one rst file per loader to document.
    
    Related to T3117

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

vlorentz added a subscriber: vlorentz.

Looks great!

This revision is now accepted and ready to land.Apr 22 2022, 7:49 PM

Use a table to enumerate available loaders instead of a grid (see updated diff description).

Build is green

Patch application report for D7637 (id=28279)

Rebasing onto 1be5975ec6...

Current branch diff-target is up to date.
Changes applied before test
commit 0e01b00498cdbfc3d43dd68233a21a1e9029fd14
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Apr 20 16:22:18 2022 +0200

    user: Bootstrap loaders high-level documentation
    
    Add landing page of loaders high-level documentation displaying
    available ones in a table with the following column:
    
      - logo and name of the loader linking to its specific documentation
    
      - related links: source code, developer doc, development activity
    
      - current status: production, staging or development
    
      - link to related grant if any
    
    Create one rst file per loader to further document.
    
    Related to T3117

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

Update Bazaar loader status as it is now deployed to production.

Build is green

Patch application report for D7637 (id=28294)

Rebasing onto 1be5975ec6...

Current branch diff-target is up to date.
Changes applied before test
commit dc96f6a8ecb772447b65718b202db70cc64b167f
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Wed Apr 20 16:22:18 2022 +0200

    user: Bootstrap loaders high-level documentation
    
    Add landing page of loaders high-level documentation displaying
    available ones in a table with the following column:
    
      - logo and name of the loader linking to its specific documentation
    
      - related links: source code, developer doc, development activity
    
      - current status: production, staging or development
    
      - link to related grant if any
    
    Create one rst file per loader to further document.
    
    Related to T3117

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