consul/website/README.md

# Consul Website

This subdirectory contains the entire source for the
[Consul Website](https://www.consul.io/). This is a
[Middleman](http://middlemanapp.com) 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:

```shell
$ make website
```

You must have Docker installed for this to work.

Alternatively, you can manually run the website like this:

```shell
$ bundle
$ bundle exec middleman server
```

Then open up `http://localhost:4567`.
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 19:49:52 +00:00			`# Consul Website`
website: bulk copy from serf 2014-02-08 00:41:03 +00:00
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 19:49:52 +00:00			`This subdirectory contains the entire source for the`
			`[Consul Website](https://www.consul.io/). This is a`
			`[Middleman](http://middlemanapp.com) project, which builds a static site from`
			`these source files.`
website: bulk copy from serf 2014-02-08 00:41:03 +00:00
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 19:49:52 +00:00			`## Contributions Welcome!`
website: bulk copy from serf 2014-02-08 00:41:03 +00:00
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 19:49:52 +00:00			`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.`
website: bulk copy from serf 2014-02-08 00:41:03 +00:00
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 19:49:52 +00:00			`## Running the Site Locally`
website: bulk copy from serf 2014-02-08 00:41:03 +00:00
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 19:49:52 +00:00			`To run the site locally, clone this repository and run:`
website: bulk copy from serf 2014-02-08 00:41:03 +00:00
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 19:49:52 +00:00			```shell
			`$ make website`
			```
website - how to build & deploy site 2014-09-02 16:20:37 +00:00
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 19:49:52 +00:00			`You must have Docker installed for this to work.`
website - how to build & deploy site 2014-09-02 16:20:37 +00:00
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 19:49:52 +00:00			`Alternatively, you can manually run the website like this:`
website - how to build & deploy site 2014-09-02 16:20:37 +00:00
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 19:49:52 +00:00			```shell
website - how to build & deploy site 2014-09-02 16:20:37 +00:00			`$ bundle`
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 19:49:52 +00:00			`$ bundle exec middleman server`
website - how to build & deploy site 2014-09-02 16:20:37 +00:00			```

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 19:49:52 +00:00			Then open up `http://localhost:4567`.