Chapter website

This site uses the Haymarket theme.

Contributing & branching info

The two primary branches in this repo are prod and staging. When making contributions, always branch off of and merge back into staging first. The staging branch is deployed here via Netlify, and after merging your changes, they will automatically deploy to that link. Once changes are verified and stable, staging can then be merged into prod which is deployed via GitHub pages. For access to the staging instance on Netlify, reach out to @nickharrisdev here on Github or in the CDSA slack.

Running Locally

The website can be run locally in order to test out changes. Make sure you have ruby and bundler installed.

Once you clone the repo, make sure you are in the project root and run bundle install to install all the dependencies.

To start a local version of the site at http://localhost:4000, run:

bundle exec jekyll serve --livereload

The --livereload option watches the source files and automatically updates the site. It's not necessary but if you are making edits you will probably want to do this.

Updating content

The homepage can be edited by opening _homepage/en/index.md and clicking on the Edit this file button.

• It's written in Markdown.
• Here's a 2-page PDF that contains syntax examples.

Pages within a collection, such as Defund CPD, live in their own folders.

• _campaigns contains the Markdown files that generate individual campaign pages.
• Generated URL: my-website.org/collection-name-without-underscore/page-name/

Single pages, such as New members, live in the _pages folder.

• Generated URL: my-website.org/page-name/

Adding "Updates"

1. Add a markdown file to the _posts/ subdirectory with the filename format yyyy-mm-dd-post-title.md. Jekyll uses the date in the filename to organize the updates, so it is important that they are formatted this way.

2. Add your update content to the file, and it will appear listed on your-base-url.com/updates

3. If desired, you can control the index page title (if you want something other than "Updates", like "blog" or "announcements") by changing the name of the updates/ directory and the front matter of updates/index.html accordingly.

Posts are native/baked-in to Jekyll. For more info on how they can be utilized, check out their documentation.

Updating events

Events are managed on teamup. Instructions for adding new events to the calendar are here.

Customizing templates

If UI customizations are required that wouldn't make sense to add to the Haymarket remote themes, the _includes/ directory can be used for this purpose.

"Backend" setup

This is a purely static website, so the only "backend" there is to speak of is what is provided by the Github pages hosting platform. There is a fair amount of documentation prodived by Github on this subject.