Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign upAdd datathon cheat sheet, resolves #68 #84
+163
−0
Conversation
ianmilligan1
requested review from
greebie
,
ruebot
and
SamFritz
Jan 3, 2019
content/aut/datathon.md
Outdated
| 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.
This comment has been minimized.
ianmilligan1
added some commits
Jan 3, 2019
SamFritz
approved these changes
Jan 3, 2019
@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.
content/aut/datathon.md
Outdated
| 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.
This comment has been minimized.
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.
This comment has been minimized.
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.
This comment has been minimized.
SamFritz
merged commit aa99390
into
master
Jan 3, 2019
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
ianmilligan1 commentedJan 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.