Page MenuHomeSoftware Heritage

Fix outdated README for listers and improve formatting
ClosedPublic

Authored by anlambert on May 13 2019, 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
Branch
fix-outdated-README
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 5690
Build 7774: tox-on-jenkinsJenkins
Build 7773: arc lint + arc unit

Event Timeline

README.md
149

I think here you should import npm lister

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

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

This revision is now accepted and ready to land.May 14 2019, 10:02 AM
README.md
117

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

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.