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

Add datathon cheat sheet, resolves #68 #84

Merged
merged 4 commits into from Jan 3, 2019

Conversation

Projects
None yet
4 participants
@ianmilligan1
Member

ianmilligan1 commented Jan 3, 2019

This adds a "cheat sheet" for datathons. I haven't linked to it from elsewhere, because I think it's fairly datathon specific, but if people want to have a link from elsewhere we could put one on the events page or the AUT page.

If you're rendering locally, page is at http://localhost:1313/aut/datathon/

This is fairly tricky writing to explain complicated concepts to a general audience, so all suggestions and comments eagerly accepted.

@ianmilligan1 ianmilligan1 requested review from greebie , ruebot and SamFritz Jan 3, 2019

@ruebot

ruebot approved these changes Jan 3, 2019

Looks good to me!

date: 2019-01-01T11:51:41-04:00
---

This guide is meant to be a quick reference guide for attendees at the Archives Unleashed [datathons](/events). These are commonly-asked questions and options that attendees have used, and may be dynamically updated during events.

This comment has been minimized.

@ruebot

ruebot Jan 3, 2019

Member

strike dynamically

@greebie

greebie approved these changes Jan 3, 2019

LGTM.

@SamFritz

@ianmilligan1, this looks great and I think provides a good reference point for those participants coming in with only a bit of experience. Walk though makes sense and gives them a good snapshot of how to get set up.

My suggestions are related to how text displays.

The trick is connecting to them.

To do so, you need two things:
- a file known as a private key so that you can connect to the machine securely (at our hackathons this is generally known as `archives-hackathon.key`)

This comment has been minimized.

@SamFritz

SamFritz Jan 3, 2019

Member

suggestion to either add a break so that the items appear as bullet points or number then (e.g. 1)).


Once you're on the machine, it will be preloaded with a number of collections - we will let you know the details about that in Slack.

Each of the VMs will be preloaded with:

This comment has been minimized.

@SamFritz

SamFritz Jan 3, 2019

Member

similar to above comment, I think an additional space/break is needed for this to appear as a bulleted list.


Data will be located in `/mnt/data` in a series of subdirectories. For example, a collection might be found in `/mnt/data/sfu-ngos` for the SFU NGO collection.

A few other things to keep in mind:

This comment has been minimized.

@SamFritz

SamFritz Jan 3, 2019

Member

break here

@SamFritz SamFritz merged commit aa99390 into master Jan 3, 2019

@ianmilligan1 ianmilligan1 deleted the issue-68 branch Jan 3, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment