mirror of https://github.com/hashicorp/consul
d3b6750c3b
* Adds Deployment Guide and update links * Fixes releases link * Re-organisation of content * Cuts down "deployment" doc (which should focus on Reference Architecture) by moving raft and performance tuning to the Server Performance page which already covers some of this. * Moves backups from "deployment" doc (which should focus on Reference Architecture) to "deployment-guide" * Cleans up some notes and add single DC diagram * Removes old link to deployment guide from nav * Corrects minor styling, formatting, and grammar |
||
---|---|---|
.. | ||
scripts | ||
source | ||
Gemfile | ||
Gemfile.lock | ||
LICENSE.md | ||
Makefile | ||
README.md | ||
config.rb | ||
packer.json | ||
redirects.txt | ||
report.xml |
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 website
.
Then open up http://localhost:4567
. Note that some URLs you may need to append
".html" to make them work (in the navigation).