Page MenuHomeSoftware Heritage

Fix outdated README for listers and improve formatting
ClosedPublic

Authored by anlambert on Mon, May 13, 3:26 PM.

Details

Summary

While working on the Phabricator lister with @nahimilega,
I found out that the README for swh-lister was quite outdated
(https://forge.softwareheritage.org/D1365#32391).

That diff updates the README with up to date instructions
for configuring / running a lister.

I also removed a deprecated configuration entry that is no more used
in the current code.

Diff Detail

Repository
rDLS Listers
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.Mon, May 13, 3:26 PM
nahimilega added inline comments.Mon, May 13, 3:30 PM
README.md
150 ↗(On Diff #4790)

I think here you should import npm lister

anlambert added inline comments.Mon, May 13, 3:34 PM
README.md
150 ↗(On Diff #4790)

Right!

anlambert updated this revision to Diff 4791.Mon, May 13, 3:35 PM

Fix typo in README

ardumont accepted this revision.Tue, May 14, 10:02 AM

Thanks for the update.
Sounds good to me.

I added @douardda as reviewer as he is working on the lister initialization/registering part (which might land, thus changing this again ;)

Cheers,

README.md
117 ↗(On Diff #4791)

I used the previous format so that we could easily copy/paste but meh ;)

This revision is now accepted and ready to land.Tue, May 14, 10:02 AM
anlambert added inline comments.Tue, May 14, 10:48 AM
README.md
117 ↗(On Diff #4791)

Ack, will turn those snippets into a script form rather than a REPL session

anlambert updated this revision to Diff 4794.Tue, May 14, 11:00 AM

Update: Turn Python code snippets from REPL forms to script ones to ease copy / paste

This revision was automatically updated to reflect the committed changes.