github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/website
History
Paul Banks 360e3acc7c Add common blocking implementation details to docs (#5358) 
* Add common blocking implementation details to docs

These come up over and over again with blocking query loops in our own code and third-party's. #5333 is possibly a case (unconfirmed) where "badly behaved" blocking clients cause issues, however since we've never explicitly documented these things it's not reasonable for third-party clients to have guessed that they are needed!

This hopefully gives us something to point to for the future.

It's a little wordy - happy to consider breaking some of the blocking stuff out of this page if we think it's appropriate but just wanted to quickly plaster over this gap in our docs for now.

* Update index.html.md

* Apply suggestions from code review

Co-Authored-By: banks <banks@banksco.de>

* Update index.html.md

* Update index.html.md

* Clearified monotonically

* Fixing formating
 		2019-02-21 15:33:45 -06:00
..
scripts Fix some broken links in docs (#4858) 2018-10-26 10:55:12 -07:00
source Add common blocking implementation details to docs (#5358) 2019-02-21 15:33:45 -06:00
Gemfile update middleman-hashicorp to 0.3.35 2018-04-13 09:11:32 -07:00
Gemfile.lock website: update nokogiri (#5252) 2019-01-22 21:49:16 +01:00
LICENSE.md Update license 2017-03-08 11:40:06 -08:00
Makefile Update middleman docker image to 0.3.35 2018-04-13 09:22:12 -07:00
README.md Update middleman-hashicorp 2017-03-08 11:26:11 -08:00
config.rb Release v1.4.2 2019-01-28 21:46:00 +00:00
redirects.txt update redirects doc comment for clarity 2018-11-19 15:28:32 +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).