Merge pull request #49 from emiliom/upd_config

Added web site editing instructions and updated README

Author: emiliom

InstructionSiteUpdates.md

@@ -0,0 +1,38 @@
+# Editing OHW web site content and layout
+
+The OceanHackweek web site is a Jekyll site that uses the [Jekyll Spectral theme.](http://jekyllthemes.org/themes/spectral/)
+
+### Location of main content documents
+
+Relevant, editable content is organized in the following directories and files:
+
+- [_config.yml](https://github.com/oceanhackweek/oceanhackweek.github.io/blob/master/_config.yml): core Jekyll site configuration, including some banner/header/footer text and urls
+- [jekyll-spectral-theme/_includes](https://github.com/oceanhackweek/oceanhackweek.github.io/tree/master/jekyll-spectral-theme/_includes) directory: front page content, broken up into sections, one markdown file per section.
+  - The layout templates for sections and section order are controlled by [jekyll-spectral-theme/_layouts/default.html](https://github.com/oceanhackweek/oceanhackweek.github.io/blob/master/jekyll-spectral-theme/_layouts/default.html)
+  - Each section specifies a template for its layout, where the templates available are found in [jekyll-spectral-theme/_layouts](https://github.com/oceanhackweek/oceanhackweek.github.io/tree/master/jekyll-spectral-theme/_layouts)
+  - Section two ("Information for Applicants") is a special beast. While [jekyll-spectral-theme/_includes/section-two.html](https://github.com/oceanhackweek/oceanhackweek.github.io/blob/master/jekyll-spectral-theme/_includes/section-two.html) orchestrates it, the directives there point to content to be grabbed from tags `title` and `description` in [_pages/01-applicants.md](https://github.com/oceanhackweek/oceanhackweek.github.io/blob/master/_pages/01-applicants.md)
+- [_pages](https://github.com/oceanhackweek/oceanhackweek.github.io/tree/master/_pages): content for extra pages, including all the pages accessible via the drop-down menu on the upper right of the page.
+  - The destination page file name (what a user sees) is *not* the source markdown file name on the repository; instead, the destination file name is found in the `permalink` tag within the markdown file. For example, for [_pages/01-applicants.md](https://github.com/oceanhackweek/oceanhackweek.github.io/blob/master/_pages/01-applicants.md), the destination file name is [applicant-info.html](https://oceanhackweek.github.io/applicant-info.html)
+
+There might be more; these are the ones I'm certain about.
+
+
+### Editing and testing locally (in your computer) with Jekyll
+
+Clone the GitHub repo locally, then edit the content of files following the documentation in the previous section. To view your changes, rebuild the site using Jekyll.
+
+Install Jekyll locally through conda with:
+
+```shell
+conda create --name JEKYLL rb-bundler compilers
+conda activate JEKYLL
+bundle install
+```
+
+To build and serve the site, run this statement:
+
+```shell
+bundle exec jekyll serve
+```
+
+The site will be available at `http://127.0.0.1:4000/`.

README.md

@@ -1,3 +1,16 @@
-# oceanhackweek.github.io
+# OceanHackweek web site
 
-2018 is archived, this is the 2019 repo. 
+This is the Github repository for the OceanHackweek (OHW) webstite, https://oceanhackweek.github.io. It's built on [Jekyll](https://jekyllrb.com).
+
+**Instructions for editing the content of the site** are found in [InstructionSiteUpdates.md](InstructionSiteUpdates.md). This document lays out which files control what content and provide instructions for deploying Jekyll locally and running it to update your local edits before submitting a pull request.
+
+
+## Archived sites and pages from previous years
+
+### OHW 2019
+
+Currently the materials from 2019 are archived in a GitHub branch, https://github.com/oceanhackweek/oceanhackweek.github.io/tree/ohw19archive. Though the individual markdown pages are accessible, the site is not currently viewable directly as a web site proper. This repo hosts pages accessible from the upper-right drop-down menu; these are found in the `_pages` directory. The content for the main, "front" page is found on the Jekyll sub-model repo https://github.com/oceanhackweek/jekyll-spectral-theme, in the `_includes` directory.
+
+### OHW 2018
+
+The site is archived at https://github.com/oceanhackweek/ohw2018 and is viewable at https://oceanhackweek.github.io/ohw2018/. In addition, currently (3/17/2020) the 2018 Projects and Schedule pages are visible from the drop-down menu on the main site, and the corresponding markdown pages are found at https://github.com/oceanhackweek/oceanhackweek.github.io/blob/master/_pages/z-projects_2018.md and https://github.com/oceanhackweek/oceanhackweek.github.io/blob/master/_pages/z-schedule_2018.md, respectively. We plan to remove these soon.