github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/website
History
Blake Covarrubias 0aa025df1c
docs: Miscellaneous docs cleanup (#6742) 
Fix spelling errors, API doc inconsistencies, and formatting issues.

* Fix several spelling errors.
* Prepend / to v1/event/list path in Watches.
* Rename script handlers to match Watch type.
* Remove /v1 path prefix on service health API endpoints.

Makes request path consistent with the rest of the HTTP API
documentation which does not include the /v1 prefix.

* Fix bracket formatting issue on Telemetry page.

The HTML codes used for brackets inside of the code block are not
interpolated, and are shown as literal strings.

Replace the numeric HTML codes with the intended character value to
fix display formatting.

Also placed variable reference on agent/options.html inside code block
for consistency with the presentation of other options on the page.

* Add missing word to Coordinate.Node docstring.

Resolves #6014
 		2019-11-05 20:34:46 -08:00
..
raw-assets Initial L7 Documentation (#6056) 2019-07-08 21:11:19 -05:00
scripts modify netlify-cli installation (#6674) 2019-10-23 13:54:19 -04:00
source docs: Miscellaneous docs cleanup (#6742) 2019-11-05 20:34:46 -08:00
Gemfile website: Update middleman-hashicorp container and Gemfile.lock (#6374) 2019-08-27 11:05:18 -04:00
Gemfile.lock website: Update middleman-hashicorp container and Gemfile.lock (#6374) 2019-08-27 11:05:18 -04:00
LICENSE.md Update license 2017-03-08 11:40:06 -08:00
Makefile website: Update middleman-hashicorp container and Gemfile.lock (#6374) 2019-08-27 11:05:18 -04:00
README.md Update middleman-hashicorp 2017-03-08 11:26:11 -08:00
config.rb Release v1.6.1 2019-09-12 19:39:59 +00:00
report.xml Starting Docs (#46) 2018-06-25 12:24:05 -07: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 website.

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