actual site

HOWTO CAMS

Recipe for editing only online

1. have github account
2. go to github.com/aims-ghana/seams
3. use the "fork" button (top right-ish)
4. ...wait til done
5. looking at fork, switch to gh-pages branch if not already there (selector box for branch)
6. navigate through files to target (e.g., README.md in this case)
7. when viewing target, click edit button (pencil, top left of view panel)
8. ...make edits
9. scroll down to bottom of screen
10. enter useful headline for edits
11. if more details useful, enter them as well in big text box
12. commit (directly to gh-pages branch)
13. click pull request (button to the side of resulting view below button for code (looks like "<>"))
14. select gh-pages branch in aims-ghana and your repositories, then click buttons to proceed (there are a few, with different names, but all green)
15. can continue to make updates while waiting for pull to be accepted, and all will be included
16. once pull accepted, trash fork
17. repeat as necessary

Recipe for editing locally

1. have github account
2. have git (recommend github's client - right level of bells and whistles)
3. have plain text editor (recommend atom, though sublimetext is also good, Notepad++ if stuck w/ windows environment)
4. have jekyll installed (recommend using the ruby gem github-pages to accomplish this)
5. fork repo online (see above), then clone your repo
6. cd into clone (e.g., $ cd ~/A_DIR_FOR_REPOS/seams)
7. open site in text editor (e.g., $ atom .)
8. launch local copy of site ($ ./run.sh will fire it up on localhost:4000)
9. ...make edits, review edits w/ browser...
10. push changes to your repo
11. pull request from your repo into aims-ghana/seams repo
12. to continue using your repo, use $ ./rebase.sh. You may need include the following your .git/config so that aims-ghana/seams is upstream remote:

```
[remote "upstream"]
    url = https://github.com/AIMS-Ghana/seams.git
    fetch = +refs/heads/*:refs/remotes/AIMS-Ghana/*
```

13. other, trash repo + fork and clone per step 5

More General Developing material

1. learn git, github, github pages (though start here for from-scratch-diy), jekyll
2. CAMS material is organized into sections, with material for each day/session combo. A workshop day generally entails warmup -> topic discussion / small exercises -> in-depth exercise -> individual project workshopping from the perspective of that topic. The folders for the material are as follows:

• _warmups: both in-class and background material for daily warmup exercises. should specify any directions, link to any material to download, what people will be expected to "turn in"
• _sessions: both in-class material for the in class discussion of a topic. should contain / link to any presentation material, exercise downloads, exercise instructions, etc. presentation notes should go here as well.
• _topics: "textbook" material for each session. should go beyond in class discussion, and serve as reference material. some duplication of _sessions material may be warranted, but probably not very much
• _practice: detailed guidance for each stage of the long form exercise + discussion of how it relates to in-class + reading material
• _project: detailed discussion of particular project milestones + guidance for what students need to present at the end of the self-directed work period.

3. for each of our responsible areas, we need to assemble the above in a fork, then issue a pull request to integrate it into the main repository. Recommend that we do that in small bites. We'll develop the material in stages, with outlines that get revised / filled in with increasing levels of detail