Skip to content

genericitperson/2000-class-association.github.io

Repository files navigation

2000 Class Association website

How does this work?

This website is build using the static website generator Jekyll. That means that all content is generated as static pages: all pages look the same for all visitors and there is no dynamic content.

Technically

  • GitHub Pages is the service that runs Jekyll to generate HTML pages from Markdown-formatted text files in this repository. Every time a change is made, a new set of HTML pages is generated. The Ruby libraries required to build the website are defined in the Gemfile file.

  • The website is also rebuilt daily. This is done by the Travis CI service as configured in the .travis.yml file. The daily rebuild is required to update pages containing time-dependant information such as upcoming events.

    Daily build status: Build Status

  • Every time a change is made, a GitHub Actions workflow will run verifying that all generated pages are valid HTML5. If this action fails, log messages should be inspected and content or page templates updated as required for the validation test to pass.

  • General website configuration and meta data are included in the _config.yml file.

  • Content can be edited through the Forestry.io service. This is a user-friendly Content Management System built for static websites. The website administrator will need to assign the relevant permissions in Forestry.io to edit this website. Alternatively, content could be directly edited from the GitHub repository.

  • In addition to HTML pages, the website generates an RSS feed (/feed.xml) and an iCalendar of upcoming events (/events.ics).

  • The CNAME file contains the domain name this website responds to. DNS settings must be configured as documented (see Using a custom domain with GitHub Pages).

  • To test the website on your own (Windows 10) computer, install Docker, clone the repository and run the script run.ps1 in PowerShell. Then open a webbrowser and load the website using the URL http://localhost:4000/.

  • To build the website and verify that all pages are valid HTML5 run the script validate.ps1.

DNS settings

The 2000 Class Association owns the following domains:

Domain Purpose Registrar DNS hosting
2000class.org Primary website Purely Domains Namecheap
2000class.org.uk UK alias Namecheap Namecheap
laser2000.org.uk Historic Namecheap Namecheap
festivalofsailing.co.uk Event Namecheap Namecheap

Terms and conditions

All copyrights are owned by the 2000 Class Association.

The source code of this website is released under the GNU General Public License (GPL), version 3 .

The content of this website is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) licence.