Measurement Lab Source Code
This is the source code of the Measurement Lab website built using Jekyll and utilizing GitHub Pages to publish and host the site.
Current Build Status is:
Please Note This repository contains a submodule, so after cloning this repo, you will also need to run git submodule init and git submodule update to pull down the submodule files as well.
- Install dependencies
bundle install - Run Jekyll server and pass in a blank baseurl to preview in development mode
jekyll serve --baseurl. - View the generated site by going to http://localhost:4000/
Developers should also install the pre-commit hook that comes packaged with this repository that will alert about any trailing whitespaces to minimize git diff noise. In order to install the pre-commit hook, run the following commands to create a symbolic link:
rm -rf .git/hooks/
cd .git/
ln -s -f ../_hooks hooksThis site enables HTML Compression for optimizing performance. If it is desired to not compress pages while doing development, developers can simply remove the layout: compress from the default template in the _layouts folder.
| Directory | Description |
|---|---|
| _data | Directory contains yml files that contain content that is not within individual pages or posts. |
| _includes | Contains several partials that are common to several generated pages. |
| _layouts | Contains the templates that are used to generate the commonality of the pages (default is the main one that all the pages use. |
| _pages | Contains all non-blog post pages. Pages that have a number prepended to the filename signifies that they are used to dynamically generate the main navigational header. They will display in the header in the order of the prepended numbers. These pages also must contain the menu-item: true frontmatter in the pages. |
| _posts | Contains all of the individual blog entries. |
| css | Contains the css for the project. |
| fonts | Contains the customized font libraries for the project. |
| js | Contains the js libraries for the project. |
| images | Contains all the image files for the site |
| publications | Contains all the pdfs and docs that the site links too |
This section highlights the coding standards to be used for this project to ensure consistency across the codebase for current and future development
- Should be all lowercase and words are concatenated with a hypen
- All yml frontmatter keys should be lowercase and words concatenated with a hyphen
- All liquid variables are following an underscore pattern so they can be easier to differentiate from yml frontmatter variables
- All liquid tags, objects, and filtesr will have spaces in front of and following whatever is contained within braces
Travis is configured (via .travis.yml) to take the following actions after a push:
- Build a static Jekyll site from the source.
- Deploy the built site to Amazon S3.
In order to deploy to S3, the secret key for the Amazon AWS IAM account to be used must be encrypted in .travis.yml. The secret key is encrypted using the public key for the repository in Travis CI. If the Amazon credentials change, then the keys in .travis.yml will need to be updated. The access_key_id can be entered in plain text, but the secret key should be encryped using the travis CLI utility like so:
$ travis encrypt secret_access_key:<SECRET KEY> -r m-lab/m-lab.github.io
In addition to deploying the site to S3, Travis also handles invalidating the Amazon CloudFront cache each time a new version of the site is pushed. This is handled via the cf-s3-invalidator gem. This utility makes use of the file _cf_s3_invalidator.yml.enc, which is an encrypted file generated with the encrypt-file command of the travis CLI utility. The README.md for the cf-s3-invalidator utility has some information on how to create a _cf_s3_invalidator.yml file. You can then encrypt the file with a command like:
$ travis encrypt-file -r m-lab/m-lab.github.io _cf_s3_invalidator.yml --add
Delete the unencrypted file after running the above command and be sure to not commit the unencrypted file to the repository.