mirror of https://github.com/status-im/consul.git
5412ba9dad
- Remove duplicate install instructions from the Helm Chart page and kept them in Running Consul - Renamed Helm Chart to Helm Chart Reference because that's mostly what it contains (along with some examples) - Renamed Running Consul to Installing Consul - Changed instructions to be for installing using Helm 3 and added notes if using Helm 2 - Used release name "hashicorp" so subsequent instructions can be more concise and pastable, e.g. "port forward to svc/hashicorp-consul-server" vs. "port forward to svc/<your release name>-consul-server" - Use config.yaml as the name for the override values file since it differentiates from the default values.yaml file and its the name of the file used in the helm docs (https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing) |
||
|---|---|---|
| .. | ||
| raw-assets | ||
| scripts | ||
| source | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE.md | ||
| Makefile | ||
| README.md | ||
| config.rb | ||
| 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).