datasets icon indicating copy to clipboard operation
datasets copied to clipboard

Clean up documentation for PublicGitArchive

Open eiso opened this issue 6 years ago • 9 comments

  • [ ] Remove pga.sourced.tech (it is a nightmare to maintain yet another site)
    • [ ] Remove web folder
  • [ ] Remove examples folder (examples can be part of docs, docs/examples.md)
  • [ ] Move borges-indexer, pga, multitool into a new folder src
  • [ ] Convert PublicGitArchive/README.md into an introduction to PublicGitArchive with a quickstart, including the details of the dataset that are currently only on web (essentially an abridged version of the readme style we use for engine)
  • [ ] Move the current content of the README related to borges-indexer & multitool into docs/reproducing-pga,md

@smola @campoy @vmarkovtsev please review this proposal

eiso avatar Aug 30 '18 08:08 eiso

@eiso Will we still serve the files from pga.sourced.tech?

vmarkovtsev avatar Aug 30 '18 09:08 vmarkovtsev

pga.sourced.tech needs to continue serving the files so that we keep compatibility with released tools.

smola avatar Aug 31 '18 10:08 smola

I have no issue with serving from pga.sourced.tech just want to get rid of the website. Since @campoy is on holidays, if @smola and @vmarkovtsev agree, I can start working on this.

eiso avatar Aug 31 '18 13:08 eiso

I +1

vmarkovtsev avatar Aug 31 '18 13:08 vmarkovtsev

Interesting feedback in this issue: src-d/datasets#77

m09 avatar Sep 13 '18 09:09 m09

What's the current status of this? If I was to work on better documenting PGA, how would I start?

@smola can you update on the tasks that Eiso mentioned above, please?

campoy avatar Oct 11 '18 23:10 campoy

@campoy None is done. I think consolidating into a standard gitbook would be a good first step.

See https://docs.sourced.tech/datasets/publicgitarchive

smola avatar Oct 16 '18 08:10 smola

This is relevant to the conversation we had this morning about website content responsibilities with @marnovo and @vcoisne

campoy avatar Oct 16 '18 20:10 campoy

This was one year ago, but it feels like a whole epoch has passed. I am finally working on this.

vmarkovtsev avatar Sep 24 '19 15:09 vmarkovtsev