The website for the Swinburne Cyber Security Club - contains a website, blog, and wiki
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_root
hooligan @ 8e29d72
media
news
plugins
.gitignore
.gitmodules
CNAME
Future model for publishing content.md
Gemfile
Gemfile.lock
README.md
config.yml
data.yml
google19f7847be3614a04.html

README.md

Swinburne Cyber Security Club website

Published at: http://scsc.wtf

Introduction

This is a static website built using the excellent Ruhoh static website builder. Ruhoh is modular and allows you to maintain a clean site folder, with only the files you need to override to get the job done. It appears to be simpler to use than more popular static website builders such as Jekyll/Octopress, or Middleman.

Static websites are fast, and using one allows us to be hosted on GitHub Pages. Because the website is static, you must build the site after any updates before pushing your changes back to GitHub; read about how to easily make and publish a content update below.

For all other instructions, please read the Ruhoh documentation if you need to – it's nice and concise. If there are some instructions missing from this Readme, feel free to contribute them =)

To be granted direct write access to this repository via membership of the swin-scsc GitHub Organisation, contact us at swin.scsc@gmail.com or post on our Facebook group.

Site contents

  • Website
  • TODO: Blog
  • TODO: Wiki

Updating content

Setup

Git

Make sure you have Git installed.

Clone the repository:

git clone https://github.com/swin-scsc/scsc-website.git
cd scsc-website

Clone the submodules:

git submodule update

Ruby

Make sure you have Ruby installed (2.2.2 is good – best to use a version manager like rbenv).

Install the Ruby Gems listed in the Gemfile, and their dependencies:

bundle install

All Ruby gem commands should be prefixed with bundle exec so as to limit the command to only using the versions of the gems we have specified in the Gemfile. I'd recommend adding the following line to the bottom of your ~/.bashrc profile so you can just type be whenever you see bundle exec. Open a new terminal window for it to take effect.

alias be='bundle exec'

Local server

You can test your changes locally by running:

bundle exec ruhoh server

or just:

bundle exec ruhoh s

You can then access the site at http://localhost:9292/

Most changes are shown simply by saving the file and refreshing the webpage; however, note that changes to some Ruhoh data files do require restarting the server (not knowing this almost had me pulling my hair out in frustration at one point!)

Publishing content

First, make sure the content you're about to publish has been committed and pushed:

git commit --all
git push origin HEAD

Then, build and publish to GitHub Pages:

bundle exec ruhoh publish github

[Future model for publishing content](Future model for publishing content.md)