Improve docs #32
Improve docs #32
Conversation
| * [Tags](#tags) | ||
| * [Changing the Tags Header](#changing-the-tags-header) |
There was a problem hiding this comment.
Changing the Tags Header => Custom Tags Header
|
looks good, making a good doc even better! i think we soon are really fine on this. added a few comments, but feel free to ignore them. this branch needs a rebase, however. |
|
can we wrap this one up too? |
|
Wait for it... still working on this one. 😉 |
|
Okay, this should do it. Have a look and let me know what you think. |
|
|
||
| Use the CacheInvalidator to explicitly invalidate or refresh paths, URLs or | ||
| headers. | ||
| It is the [cache invalidator](cache-invalidator.md) that you will probably use |
There was a problem hiding this comment.
why link to self? and i think i would re-order the 2 sentences to first say what it does, then that you use this most. or maybe say "It is the main class to interact with this library."
There was a problem hiding this comment.
Whoops, copy/paste trouble. ;)
|
wow, a lot of doc. i will go through it all with more time tonight. |
|
Sure, no problem. Let’s wait with the transfer to FOS for this PR to be merged. But it should really be the last thing before we release this. ;) |
| -------- | ||
|
|
||
| This library mainly consists of: | ||
| * low-level clients for communicating with caching proxies |
There was a problem hiding this comment.
can we say (varnish, nginx) here? just to not confuse people with our generic terminology :-)
| ```php | ||
| use FOS\HttpCache\Invalidation\Varnish; | ||
|
|
||
| $servers = array('10.0.0.1:6081', '10.0.0.2:6081'); |
There was a problem hiding this comment.
without port, the connection would be attempted at port 80, right?
There was a problem hiding this comment.
Yep. I’ll add it to the docs.
|
okay, went through now. very cool! |
|
Thanks for your detailed comments. I’ll update this PR tonight, so we can merge it and move the repo to FOS. |
|
Some good criticism there! Fixed stuff and squashed commits. |
Remove whitelines
Add HHVM compatibility as feature Update TOC Split Varnish into client and config Improve docs on proxy client Clean up Installation chapter Add flush() to examples so users won't forget to call it Add proxy config chapter Finish general introduction Fix links to introduction Fix missing ; Fix grammar Fix code block Update cache-invalidator.md Remove link to self Fix link to Alternatives Fix host regex Add missing Composer install step Add note on Varnish port Improve overview Improve introduction
|
Removed the duplicate invalidation examples in the Varnish Clients chapter. This can be merged. |
|
cool, thanks a lot! |
No description provided.