search

metafacture / metafacture-documentation

The central place for documentation about metafacture
http://metafacture.github.io/metafacture-documentation/
Apache License 2.0
3 stars 3 forks source link

Automatically back up issues #1

Closed fsteeg closed 8 years ago

fsteeg commented 8 years ago

In our get together at SWIB15 (see [1]) we decided to use the issue tracker in this repo as our central place for all kinds of documentation. Since issues are not part of the Git repo, we decided to set up automatic backups for the issues using the GitHub API.

[1] http://etherpad.lobid.org/p/swib15-metafacture

fsteeg commented 8 years ago

Set up automatic backups, available at: http://lobid.org/events/metafacture/backup

It's basically a copy of the response to this GitHub API call: https://api.github.com/repos/culturegraph/metafacture-documentation/issues?state=all

A backup is created on any GitHub issues event, using a webhook posting to: http://lobid.org/events/metafacture

That service is implemented in: https://github.com/hbz/events (see https://github.com/hbz/events/issues/4 for some implementation details).

guenterh commented 8 years ago

@fsteeg Thanks Fabian for the setup of this backup. I haven't had the time to look into the details - it's interesting to use the Git API with events. I have heard of it but haven't used it so far.

Related to the documentation itself: Hopefully I can start to put some first documentation as a starter into the repo of our project work done so far this week. Last week it wasn't possible.

I would like to add additional Github accounts of other "Metafactures" as team-members for this repo. But as far as I can see you have already write permissions for the whole Culturegraph namespace?

Best wishes to Cologne Günter

fsteeg commented 8 years ago

@guenterh I have admin access to this repo for setting up and testing the webhook (for the backups). I don't have write permissions or admin access to the other Culturegraph repos. Perhaps @cboehme can give you admin access for this repo to add other members or add them for you.

guenterh commented 8 years ago

@fsteeg Christoph already granted admin access to me for the doc repository. I'm going to add additional users soon, Günter @cboehme fyi

fsteeg commented 8 years ago

The current backup contains the issues only, without comments. We need to include data like:

https://api.github.com/repos/culturegraph/metafacture-documentation/issues/1/comments

fsteeg commented 8 years ago

The comments are now backed up in a comments_data field for each issue.

See: http://lobid.org/events/metafacture/backup