From 5bc735090834d6c16e71c8cff84e90004e6e2989 Mon Sep 17 00:00:00 2001 From: Thomas Wood <thomas.wood09@imperial.ac.uk> Date: Fri, 5 Feb 2016 13:59:11 +0000 Subject: [PATCH] Don't exclude README.md It may be useful to keep in /vol/rr/www so that future people joining the group know where to look for edit access. --- README.md | 17 ++++++++++++----- _config.yml | 1 - 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 669266c..c22730e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +--- +layout: null +--- + Program Specification & Verification Group Website: http://psvg.doc.ic.ac.uk/ ============================================================================= @@ -6,6 +10,8 @@ Program Specification & Verification Group Website: http://psvg.doc.ic.ac.uk/ The source code for [this site](http://psvg.doc.ic.ac.uk) is [hosted on the DoC GitLab server](https://gitlab.doc.ic.ac.uk/resource-reasoning/www-rw.doc.ic.ac.uk), you should have access to edit it if a member of the resource-reasoning group. +**DO NOT EDIT THE SOURCE CODE IN `/vol/rr/www`, IT IS ALL REPLACED EACH TIME THE SITE IS REBUILT FROM VERSION CONTROL** + Technical Detail ---------------- This website is built using the [Jekyll](http://jekyllrb.com/) website framework. @@ -25,8 +31,9 @@ permalink: /my-custom-page-path/ ``` Variables that templates currently take into account are: -* title, sets the page title -* menu, (default: true) places the page into the website's navigation menu + +* `title`, sets the page title +* `menu`, (default: false) places the page into the website's navigation menu The main content of the page should then follow. @@ -42,10 +49,10 @@ are consistent. An additional check that external links are still live is also run, but this test is permitted to fail without blocking the deployment. -The site is deployed to `/vol/rr/www-rw` automatically on successful build. +The site is deployed to `/vol/rr/www` automatically on successful build. -Local Testing -------------- +Locally Building and Testing +---------------------------- If you wish to test the site locally, ensure you have ruby installed, and then initially run: ``` gem install bundler diff --git a/_config.yml b/_config.yml index 62de4e2..9b6615e 100644 --- a/_config.yml +++ b/_config.yml @@ -13,7 +13,6 @@ exclude: - Gemfile* - Rakefile - .gitlab-ci.yml - - README.md - vendor collections: -- GitLab