vbolshakov/snhack.github.io

The (Old!) Swindon Hackspace website

snhack.github.com

Note: master branch is overwritten during compilation.

This file details how to submit a new post. Please see the INSTALL file for full details on how to build and preview the entire site locally.

Super minimal way to add a post

Use this workflow when submitting a blog post using standard text or markdown.

Load the source/_posts folder, then click the new file icon above its listing. (show)

Name the file using the post date and title, in lowercase, according to the pattern: YYYY-MM-DD-url-safe-title.md. (show)

Enter the post metadata and content, formatted using markdown. Here's a template and some examples.

Use the Propose New File button to commit the post (to a new branch in your own fork).

The new branch will be compared to this repo. Check the changes and click the pull request link. (show)

Add a title and any other relevant info or images, then hit Send Pull Request. (show)

Please check the progress of your pull request for any fixes that may be required.

Notes on Pull Requests

Please use a new "topic" branch for each pull request. Mixing unrelated changes into the same branch complicates merging of commits upstream. Note that all additional commits made to a branch, will automatically be added to any pull requests made with that branch. tl;dr - don't make multiple pull requests from the same branch, or continue unrelated work to a branch that's already been submitted with a pull request.

Once you have sent a pull request an admin will need to build the site locally, check it renders acceptably, and then deploy your content to the live site.

You can view the progress of your pull request in its discussion thread. Notifications will normally be sent by email to those active or mentioned in the thread, as well as those watching either the thread or the related repo.

Check the fork and pull request help pages for more info.

Uploading Images

The new file icon on the github website only supports text files. You can reference images hosted on another server, but it's preferred to upload images to the site itself.

If you're familiar with git, you can commit images into a new folder located within source/_posts/_assets and named to match your post: YYYY-MM-DD-name-of-post. Assets in such a folder can be referenced using relative paths:

![MyImage](MyImageFile.jpg)

If you're unfamiliar with git, you can attach images to the discussion thread of your newly created pull request. An admin will commit them into the correct folder for you.