Git Product home page Git Product logo

gruntwork-io.github.io's Introduction

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 --livereload
  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-stage.sh -or-
  3. docker-compose run web ./push-to-s3-prod.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

See LICENSE.txt.

gruntwork-io.github.io's People

Contributors

brikis98 avatar josh-padnick avatar oredavids avatar joshmountain avatar kbariotis avatar yorinasub17 avatar sahilakos avatar eak12913 avatar bwhaley avatar robmorgan avatar etiene avatar klijakub avatar drmzio avatar mcalhoun avatar tonerdo avatar bmckissen avatar ina-stoyanova avatar ebeneliason avatar zackproser avatar dependabot[bot] avatar tsmit291 avatar rhoboat avatar infraredgirl avatar arnoschutijzer avatar jawn avatar equinox avatar jkinred avatar marinalimeira avatar autero1 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.