[Varnish] #809: Link to documentation is not discoverable
Varnish
varnish-bugs at varnish-cache.org
Mon Nov 1 22:59:59 CET 2010
#809: Link to documentation is not discoverable
---------------------------------+------------------------------------------
Reporter: nilbus | Type: documentation
Status: new | Priority: normal
Milestone: Varnish 2.1 release | Component: website
Version: trunk | Severity: normal
Keywords: usability |
---------------------------------+------------------------------------------
[http://www.varnish-cache.org/docs]
The links to the documentation are quite difficult to find, and require
reading the tiny text. You don't notice them when scanning the page, which
is what most people do when looking for information. I actually went a few
weeks thinking your documentation was quite pathetic, only consisting of
some Quick Install guides. Let's fix this.
Screenshot:
[[Image(http://www.nilbus.com/pub/grabup/2010-11-01_17.40.39.png
)]]
Links should be on the text that describes what the link goes to, never
the word "here".
I also changed "a install guide" to "an install guide" and added bold text
to improve scanability, for people looking for any of those three things.
Suggested improvement:
----
The official documentation contains an '''install guide''', a
'''tutorial''' and a '''reference'''.
We're trying to keep the official documentation in sync with the code.
Both are kept in the same source repository and both are available online.
* Documentation for the [http://www.varnish-cache.org/docs/2.1 latest
stable release]
* Documentation for [http://www.varnish-cache.org/docs/trunk trunk]
--
Ticket URL: <http://www.varnish-cache.org/trac/ticket/809>
Varnish <http://varnish-cache.org/>
The Varnish HTTP Accelerator
More information about the varnish-bugs
mailing list