open-consul/website
James Phillips 1adbcff059 Merge pull request #2383 from hashicorp/jbs-1462
Clarify retry_join addresses for #1462
2016-10-20 11:40:03 -07:00
..
scripts Update website metadata fixes 2016-04-12 20:14:56 +01:00
source Merge pull request #2383 from hashicorp/jbs-1462 2016-10-20 11:40:03 -07:00
Gemfile Update middleman 2016-09-26 16:06:52 -07:00
Gemfile.lock Gemfile was wonky 2016-09-26 16:06:54 -07:00
LICENSE.md
Makefile Add makefile and update readme 2015-10-09 18:29:08 -04:00
README.md Use HTTPS + www. where appropriate 2016-01-13 17:44:01 -05:00
Vagrantfile
config.rb Updates website to version 0.7.0. 2016-09-14 09:27:31 -07:00
config.ru
packer.json Update website metadata fixes 2016-04-12 20:14:56 +01:00

README.md

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

Running the site locally is simple. Clone this repo and run make dev.

Then open up localhost:4567. Note that some URLs you may need to append ".html" to make them work (in the navigation and such).

Building Site

Building the static version of the site and running it is simple. Clone this repo and run the following commands:

$ bundle
$ bundle exec middleman build
$ foreman start

Then open up localhost:5000.

Alternately, the site can now be deployed to Heroku or Cloud Foundry.