This is now deprecated. The NZ subsite has been subsumed into the main site repo.

Instructions are based on a linux set up but the semantic procedure (if not commands) should be the same.

#Basic set up

Install git! Get yourself a github account. Add yourself (by logging into the iccaving github account) or get someone to add you as a contributer to https://github.com/iccavingrepo/. Then set up the repo on your computer.

git clone https://github.com/iccavingrepo/nzsite.git

#Writing Trip Reports First pull the repo so you're up to date. Navigate to the directory then:

git pull

Then add your write your trip report as a markdown file (.md extenstion) to the nzsite/content/ folder. If its a standard post or trip report stick it in the nzsite/content/articles/ folder. Try to keep to the yyyy-mm-dd-placename.md filename format where possible.

##File layout There is a template.md file in the root of the nzsite repo. Copy and paste this and fill it according to the instructions within. If in doubt have a look at an existing article.

The key points are:

• There is a set of metadata at the top of each file. Make sure to fill this out
• Below the metadata, write your report
• Markdown syntax is simple and avialable online. Look it up, or look at another article to format yours. Also check this
• HTML works fine in markdown files (the same as they would in an html file) so if you can't do something with markdown just stick the html in.

##Finishing Save your .md file. Track the file in git:

git add path/to/file

Commit your file(s):

git commit -m "Put descriptive message here"

Please put in a good descirption of what you have done. E.g "Added a trip report for Yorkshire 3 15/03/15".
Finally push your changes:

git push

And that can be it. Contact whoever is in charge of the site to let them know to update it. If you want to see it yourself (good to check for formatting errors) then run:

./develop_server.sh start

This will start a web server and display the site for you locally. Navigate to localhost:8000 with your web browser to see it. It is likely that images won't show up.

./develop_server.sh stop

Will stop the sever.

#Advanced Set Up If you want to be able to build and deploy the site yourself look here, otherwise ignore. ###Installing Pelican Pelican is a python based static site generator. Install it:

pip install pelican

Install the Markdown package as that is what the trip reports should be written in:

pip install Markdown

Firstly run:

pelican content -s publishconf.py

This will build the site and output it to the output folder (shocking!). To push the site to the union server (and therefore make it live) you will need at least sftp access (can be requested via a sysadmin form). You need to get the contents of the output folder into the /home/www/htdocs/rcc/caving/newzealand/ folder. If you have ssh access (requested by emailing the sysadmin) then you can run:

rsync -avz --delete output/ [email protected]:/home/www/htdocs/rcc/caving/newzealand

Be very careful with this. It deletes the entire subsite (on the union server) and uploads it again. I don't think this is actually necessary but it avoids potential problems from old crap building up and the while the site is small it makes no difference in time.

##Photos The photos are a bit more complicated due to the photo_archive being outside of the root of the nz subsite. To do this you will need at least SFTP access.

• Make folder in appropriate location in photo_archive. e.g "/home/www/htdocs/rcc/caving/photo_archive/newzealand/YYYY-MM-DD%20-%20Placename". Note: %20 is just a space character. Your sftp client can probably handle spaces.
• Upload photos to this folder.
• Run the thumb.sh script that is in photo_archive root from the directory with your new photos. This will generate the thumbnails and small images.
• In the nz subsite there is a photo_archive folder (do not put photos here). From here copy the "index.php" file to your new photo folder.
• In the relevant article, fill out the relevent metadata. (This can be done before making the folder/uploading photos, the links will just be dead until you do) Done.