Resources

Useful Stuff

Git and GitHub

Markdown

conda

Software Carpentry and Data Carpentry

Jupyter and IPython Notebooks

Humanitarian Free and Open Source Software (HFOSS)

Articles

Books

Add Yourself to this website

This website should be maintained collectively by the members of the hackathon.

Add Yourself: Set Up

  1. (Optional) Install the build dependencies for the website. These include ruby, jekyll, and jekyll-scholar. Get started here..
  2. Fork the website repository.
  3. Clone your fork. If you have your ssh keys set up and your username is USERNAME, the command is git clone git@github.com:USERNAME/hipython
  4. Add the group fork as a remote. cd hipython && git remote add upstream git@github.com:arfc/hipython

Now, you’re ready to make changes to the website. There are a few types of changes that are common:

  • Edits to the text
  • Adding yourself to the people page
  • Creating a blog post

See below for directions on all of these.

Add Yourself: Customize

  1. Once you have done the set up steps, enter the source branch of the repository. git checkout source
  2. Add your photo to the repository (in img/people). If your name is Jane Doe, call it doej.png.
  3. Don’t forget to git add and git commit the photo git add img/people/doej.png and git commit -am "adds a photo of Jane Doe"
  4. Open the file _data/people.yml and add your details.
  5. Close the file and commit your changes (git commit -am "added Jane Doe details to people data")
  6. (Optional) Check whether your changes succeeded by typing jekyll serve from the top level directory of the website repository. Then, open a browser to localhost:4000.
  7. When you’re satisfied, push your changes to your own fork with git push origin source.
  8. Finally make a pull request from your source directory to the arfc fork of hipython.

If you’re feeling confident, you can skip the pull request. Instead, you can just push changes to the website directly with the command rake publish. Only do this if you don’t need anyone to double check your work.