- Quick start guide - A quick start guide to help new volunteers get the information they need.
- Information for volunteers - A guide to help volunteers familiarize themselves with the team’s workflow / tools.
- Information for authors - the process of submitting an article.
- MagPi MMS - how to use the MagPi MMS.
- MagPi GIT - how to use the MagPi GIT scripts.
- Layout & fonts - description of the standard layout and associated fonts.
- PDF creation - instructions for the generation of PDF for electronic and paper publication.
Setting up access
- The first step is to create a github account. Then for those on the MagPi layout team, email the editor for permission to join the github organisation.
- Since the Raspberry Pi does not have a great deal of processor power, it is better to use the command line tools to access github. For OSX and Windows there are GUI tools available for download on the github site.
Tools for LINUX or OSX
Several people would rather not read the git book. Therefore, some scripts were written to simplify the usage slightly. Git is not a replacement for good communication. Remember to update the local git repository before starting work on something and commit changes back to the repository frequently.
- Download and unpack the scripts,
wget http://themagpi.com/resources/git/mp-git-20130321.tar.gz tar xvfz mp-git-20130321.tar.gz
- Install it,
cd mp-git source install.sh
- Then use the commands as needed. The commands are,
to install and configure git. The script has no action if the installation and configuration is already okay.
The script expects that the repositories will be in a parent directory called magpi-git. (This can be overridden by setting the environmental variable MP_GIT_DIR to the full path of the parent directory.) If the magpi-git directory does not already exist,
mkdir magpi-git; cd magpi-git
to clone the issue 11 repository. The script will not clone the repository again if a local copy already exists in the present working directory. More than one repository can be requested at once. For example,
mp-git-clone.sh 11 12 13 templates
will check out the issue 11, 12 and 13 repositories, as well as the templates repository.
mp-git-commit.sh 'A message goes here' [all]
where the string 'A message goes here' should be replaced with a sensible and informative message and the text 'all' is optional. If all is used, all repositories within the mp-git/ parent directory are checked. The script adds any new few files, commits to the local repository, fetches and remote changes and then merges the local changes into the remote repository. (Git does not allow empty directories to be added)
to update the local copy with any changes from the github repository, where 'all' is optional. If all is used, all repositories within the mp-git/ parent directory are checked.
If you need to use a proxy:
HTTP_PROXY="http://username:email@example.com:port/" git config --global http.proxy $HTTP_PROXY
While git tagging is not currently scripted, the git commands can be used to tag and push the tag back to the repository. There purpose of tagging is to keep track of a version of many files at one point in time. A good application would be to tag the repository once at the time of electronic publication and then once when printing. Then one could refer to the printed version just by a tag, rather than risk some additional changes to the repository being included.
The list of tags can be viewed by typing
from within a mp-git/*/ directory.
A new tag can be added by
git tag -a magpi-templates-00-00-01 -m 'Tagging before overwriting current templates with templates which contain document bleeds'
and all tags can be pushed back to the repository
git push --tags
Tags are not pushed to the remote repository when mp-git-commit.sh is run, since the --tags flag is not included in the git push command inside that script.