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

Clean up documentation for PublicGitArchive #76

Open
6 tasks
eiso opened this issue Aug 30, 2018 · 9 comments
Open
6 tasks

Clean up documentation for PublicGitArchive #76

eiso opened this issue Aug 30, 2018 · 9 comments
Assignees
Labels
enhancement New feature or request

Comments

@eiso
Copy link
Member

eiso commented Aug 30, 2018

  • 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 eiso added the enhancement New feature or request label Aug 30, 2018
@vmarkovtsev
Copy link
Collaborator

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

@smola
Copy link
Contributor

smola commented Aug 31, 2018

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

@eiso
Copy link
Member Author

eiso commented Aug 31, 2018

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.

@vmarkovtsev
Copy link
Collaborator

I +1

@m09
Copy link

m09 commented Sep 13, 2018

Interesting feedback in this issue: #77

@campoy
Copy link
Contributor

campoy commented Oct 11, 2018

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?

@smola
Copy link
Contributor

smola commented Oct 16, 2018

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

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

@campoy
Copy link
Contributor

campoy commented Oct 16, 2018

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

@vmarkovtsev vmarkovtsev self-assigned this Sep 24, 2019
@vmarkovtsev
Copy link
Collaborator

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

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

No branches or pull requests

5 participants