/gruntwork-io.github.io

The gruntwork.io website

Primary LanguageHTMLMIT LicenseMIT

gruntwork.io website

This is the code for the Gruntwork website.

Gruntwork can help you get your entire infrastructure, defined as code, in about one day. You focus on your product. We'll take care of the Gruntwork.

Docker quick start

The fastest way to launch this site is to use Docker.

  1. git clone this repo
  2. docker-compose up
  3. Go to http://localhost:4000 to test

Manual quick start

  1. git clone this repo
  2. Install Jekyll
  3. Just the first time: bundle install
  4. Start Jekyll server: bundle exec jekyll serve
  5. Go to http://localhost:4000

Updating /assets/msword/gruntwork-terms.docx

Jekyll will automatically generate an MS Word version of our terms of service at /assets/msword/gruntwork-terms.docx using Pandoc when docker-compose up is first run. Unfortunately, when changes are made to /_data/terms-of-service.yml, these changes do not automatically re-generate a new gruntwork-terms.docx file. The current solution is to re-run docker-compose up.

Hopefully, in the future, Jekyll will support the ability to indicate which files should trigger which regeneration pages.

/assets/msword/styles.docx

If you want to edit the styles used to generate /assets/msword/gruntwork-terms.docx, update the styles saved in /assets/msword/styles.docx and re-run docker-compose up.

Deploying

To deploy the site to S3/CloudFront:

  1. Configure your AWS credentials as environment variables.
  2. docker-compose run web ./push-to-s3.sh

Technologies

  1. Built with Jekyll. This website is completely static and we use basic HTML or Markdown for everything.
  2. Gruntwork Terms Of Service Word Document is generated using Pandoc right after jekyll build when running docker-compose up.
  3. Hosted on Amazon S3, with CloudFront as a CDN. Using s3_website to automatically upload static content to S3.
  4. We use Bootstrap and Less.
  5. We're using UptimeRobot and Google Analytics for monitoring and metrics.

License

This code is released under the MIT License. See LICENSE.txt.