mirror of https://github.com/status-im/consul.git
6b487f80ff
In designing a potential UI for a configuration of `enable_tag_override`, I found the documentation confusing and lengthy. Here, I've made an attempt at re-writing this section to be more concise and clear. I also made a few small changes to the organization of this file to map explanations to the order of the properties listing at the top. I find it easier to scan docs when explanations appear in the same order they are listed at the top. For explanations that span multiple paragraphs, I provided a subheading, which also helps in linking from other pages. Finally, I removed a duplicated paragraph from the documentation. |
||
---|---|---|
.. | ||
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).