devasenainupakutika / short_format_notes Goto Github PK

If you are using these notes to run a course, we recommend that you host a copy yourself. The easiest way to do this is to use github pages and follow the instructions below.

We recommend that you fork the code61 repository and then clone your fork, instead of cloning the code61 repository directly. This helps us see how the notes are being used and makes it easier to incorporate any modifications you make back into the central version.

The notes use the jekyll static site generator. You can will need to install this dependency before building the notes locally:

gem install jekyll

Once you have jekyll installed you can build and view the notes by running:

jekyll serve

Although jekyll is the system used to compile and generate github pages sites, these notes won't work if you just push them to github as they rely on a custom build plugin (so that files in the _sessions folder compile correctly). Instead you need to generate the html version of the site locally.

The general idea is

1. Have a separate deployment repo, whose sole purpose is to serve the github pages version of the site.
2. Build the site locally.
3. Copy this build into a gitignored _gh-pages directory inside the project.
4. Push this directory to the deployment repo.

We've provided a rake task to make this workflow easier, but it requires that you set things up correctly first.

### Setup

1. Create a new, separate deployment repository (e.g. oxford_code61_notes) on github.

2. Clone this deployment repository down into a _gh-pages folder inside your the notes folder.

    git clone <mycourse_site_repo> _gh-pages
   

To publish the notes (in the root of the project) run:

rake publish

This will check your setup, build the notes, copy them into the _gh-pages directory and add, commit and (force) push them to the gh-pages branch of your deployment repo.

Using a custom url should be straightforward - just add a CNAME at the root level of the project and deploy as normal. (The CNAME is gitignored on the main repo, but not in the _gh-pages sub-repo, so this should all be fine.)

Assuming that you started with your own fork of the code61 repo, to update the notes you will need to pull from the original code61 central version of the repo. To do this you need to have first set up code61 as a remote:

git remote add code61 [email protected]:code61/short_format_notes.git

You can then update the notes by running:

git pull code61

To contribute, push up to your fork and submit a pull request!

These notes are licensed under a creative commons attribution license. Use and modification of the notes is encouraged (even for commercial gain) but please acknowledge me as the original creator. Pull requests will be gratefully received. Full licence details are given below.

The Code61 Notes by Tom Close is licensed under a Creative Commons Attribution 3.0 Unported License.