open-consul/website/README.md
Seth Vargo 2d29c510dc Switch to Docker-based website build process (#2448)
This has been working really well on Nomad and hashicorp.com, so I am
ready to port it out to Consul as a beta. This moves the local
development to a Docker container, which is the same container that we
use to publish the website in production. The result is much faster and
more consistent deploys.
2016-10-31 12:49:52 -07:00

772 B

Consul Website

This subdirectory contains the entire source for the Consul Website. This is a Middleman project, which builds a static site from these source files.

Contributions Welcome!

If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in.

Running the Site Locally

To run the site locally, clone this repository and run:

$ make website

You must have Docker installed for this to work.

Alternatively, you can manually run the website like this:

$ bundle
$ bundle exec middleman server

Then open up http://localhost:4567.