Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate replacement of all URLs to the mirrors on archive.org #160

Open
bzz opened this issue Mar 11, 2019 · 0 comments
Open

Automate replacement of all URLs to the mirrors on archive.org #160

bzz opened this issue Mar 11, 2019 · 0 comments

Comments

@bzz
Copy link
Contributor

bzz commented Mar 11, 2019

Despite cool uris do not change we already have issues with some paper links having HTTP 500 and not being available from time to time.

The idea is to use a mirror on archive.org instead of exact url instead and that way make urls eternal.

There is a ruby gem that should work Inventitech/url-eternalizer created with similar motivation:

This gem automatically extracts and archives URLs from a text file on Archive.org and replaces the original URL with the archived URL
URL Eternalizer can work on any ASCII text

The idea is to:

  • apply it manually on README.md and see how that works
  • create a minimal docker container that can be run though CLI on .md file in filesystem and has all the dependencies installed
  • add a pre-commit hook that runs this CLI command using that image and updates plain URLs from the README with archive.org mirror
  • add CI check that would make sure there are no un-archived URLs that were created e.g manually though GH web UI and do not follow this convention
  • update CONTRIBUTING documentation to include this convention

This would allow awesome list to include always available URLs to all scientific papers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant