Updating the Documentation for QAP

To update the documentation, you will need Jekyll (which we use to generate the html from markdown). Install it using the instructions here. Then:

1. Clone the www branch of the repo.

• git clone -b www https://github.com/preprocessed-connectomes-project/quality-assessment-protocol.git

2. Create and edit markdown files for the documentation that you wish to update/add. These will be embedded within the layout stored in _layout/page.html. You can preview all HTML pages by typing the following command in a terminal whose working directory is the repo, and then navigating to http://127.0.0.1:4000/. The pages will be updated every time you modify their corresponding markdown files.

• jekyll serve watch

4. When you are done and the pages appear as they should in the preview, generate the HTML by typing the following command. This will populate the _site directory with the rendered pages.

• jekyll build

5. Switch to the gh-pages branch of the repo.

• git checkout gh-pages

6. _site should still be present in the directory, but is ignored. Copy the html files from _site into the main directory. Add them, commit them, and push them.