Maintenance¶
Editing the book¶
There are two ways to edit the book:
1. Edit online: Open to all
Submit a proposed edit using the instructions provided above under ‘Contributing to the book’.
This will be reviewed in due course.
2. Edit on a local computer: Only open to project administrators
Clone the repository
cd /Users/petercharlton/Documents/GitHub/; git clone https://github.com/peterhcharlton/project_guidelines
Make edits to the files on a local computer.
Upload the files through a git push (as detailed here):
cd /Users/petercharlton/Documents/GitHub/project_guidelines; git add ./*; git commit -m "brief edit"; git push
Build the book locally (as detailed here):
cd ../.; jupyter-book build project_guidelines
Upload the built book to GitHub pages (as detailed here):
cd project_guidelines; ghp-import -n -p -f _build/html
Recognising contributors¶
Contributors to the Book who have GitHub accounts can be recognised using the ‘All Contributors’ app (see details here).
Creating the book¶
The book was created as follows (largely following the instructions provided here):
Steps to create the book:
Install Jupyter book via conda-forge (as detailed here)
Create a template book (as detailed here)
Modify the template to include content from Peter Charlton’s original project guidelines (available here).
Build the book (as detailed here).
Publish the book online (storing the source files in a GitHub repository, and publishing the book using GitHub pages, as detailed here).