Commit bc441fbf authored by Poul-Henning Kamp's avatar Poul-Henning Kamp

Revamp the documentation index page

parent 2437fcca
......@@ -3,74 +3,123 @@
Varnish Documentation
=====================
The official documentation contains a **install guide**, a **tutorial**
and a **reference**.
Relevant releases:
- `Documentation for the latest release
6.5 </docs/6.5/>`__
- `Documentation for the previous release
6.4 </docs/6.4/>`__
- `Documentation for the supported (LTS) release
6.0 </docs/6.0/>`__
If you run one of these release, you should *really* upgrade:
- `Documentation for the deprecated release
6.3 </docs/6.3/>`__
- `Documentation for the deprecated release
6.2 </docs/6.2/>`__
- `Documentation for the deprecated release
6.1 </docs/6.1/>`__
- `Documentation for the deprecated release
5.2 </docs/5.2/>`__
- `Documentation for the deprecated release
5.1 </docs/5.1/>`__
- `Documentation for the deprecated release
5.0 </docs/5.0/>`__
- `Documentation for the deprecated release
4.1 </docs/4.1/>`__
- `Documentation for the deprecated release
4.0 </docs/4.0/>`__
- `Documentation for old version
3.0 </docs/3.0/>`__ (unsupported)
- `Documentation for older version
2.1 </docs/2.1/>`__ (unsupported)
The bleeding edge:
- `Documentation for the current development
version </docs/trunk/>`__ (git master)
.. tabularcolumns:: l | l | l | l | l | l
.. list-table:: Direct Documentation Links
:widths: auto
* - `6.5 </docs/6.5/>`__
- `Installation </docs/6.5/installation/>`__
- `Tutorial </docs/6.5/tutorial/>`__
- `User-Guide </docs/6.5/user-guide/>`__
- `Reference </docs/6.5/reference/>`__
- Latest
* - `6.4 </docs/6.4/>`__
- `Installation </docs/6.4/installation/>`__
- `Tutorial </docs/6.4/tutorial/>`__
- `User-Guide </docs/6.4/user-guide/>`__
- `Reference </docs/6.4/reference/>`__
- Previous
* - `6.0 </docs/6.0/>`__
- `Installation </docs/6.0/installation/>`__
- `Tutorial </docs/6.0/tutorial/>`__
- `User-Guide </docs/6.0/user-guide/>`__
- `Reference </docs/6.0/reference/>`__
- LTS
* - `Trunk </docs/trunk/>`__
- `Installation </docs/trunk/installation/>`__
- `Tutorial </docs/trunk/tutorial/>`__
- `User-Guide </docs/trunk/user-guide/>`__
- `Reference </docs/trunk/reference/>`__
- Next
* - `6.3 </docs/6.3/>`__
- `Installation </docs/6.3/installation/>`__
- `Tutorial </docs/6.3/tutorial/>`__
- `User-Guide </docs/6.3/user-guide/>`__
- `Reference </docs/6.3/reference/>`__
- Deprecated
* - `6.2 </docs/6.2/>`__
- `Installation </docs/6.2/installation/>`__
- `Tutorial </docs/6.2/tutorial/>`__
- `User-Guide </docs/6.2/user-guide/>`__
- `Reference </docs/6.2/reference/>`__
- Deprecated
* - `6.1 </docs/6.1/>`__
- `Installation </docs/6.1/installation/>`__
- `Tutorial </docs/6.1/tutorial/>`__
- `User-Guide </docs/6.1/user-guide/>`__
- `Reference </docs/6.1/reference/>`__
- Deprecated
* - `5.2 </docs/5.2/>`__
- `Installation </docs/5.2/installation/>`__
- `Tutorial </docs/5.2/tutorial/>`__
- `User-Guide </docs/5.2/user-guide/>`__
- `Reference </docs/5.2/reference/>`__
- Late Middle Ages
* - `5.1 </docs/5.1/>`__
- `Installation </docs/5.1/installation/>`__
- `Tutorial </docs/5.1/tutorial/>`__
- `User-Guide </docs/5.1/user-guide/>`__
- `Reference </docs/5.1/reference/>`__
- High Middle Ages
* - `5.0 </docs/5.0/>`__
- `Installation </docs/5.0/installation/>`__
- `Tutorial </docs/5.0/tutorial/>`__
- `User-Guide </docs/5.0/user-guide/>`__
- `Reference </docs/5.0/reference/>`__
- Early Middle Ages
* - `4.1 </docs/4.1/>`__
- `Installation </docs/4.1/installation/>`__
- `Tutorial </docs/4.1/tutorial/>`__
- `User-Guide </docs/4.1/user-guide/>`__
- `Reference </docs/4.1/reference/>`__
- Antiquity
* - `4.0 </docs/4.0/>`__
- `Installation </docs/4.0/installation/>`__
- `Tutorial </docs/4.0/tutorial/>`__
- `User-Guide </docs/4.0/user-guide/>`__
- `Reference </docs/4.0/reference/>`__
- Ancient History
* - `3.0 </docs/3.0/>`__
- `Installation </docs/3.0/installation/>`__
- `Tutorial </docs/3.0/tutorial/>`__
- `User-Guide </docs/3.0/user-guide/>`__
- `Reference </docs/3.0/reference/>`__
- Bronze Age
* - `2.1 </docs/2.1/>`__
- `Installation </docs/2.1/installation/>`__
- `Tutorial </docs/2.1/tutorial/>`__
- `User-Guide </docs/2.1/user-guide/>`__
- `Reference </docs/2.1/reference/>`__
- Neolithic
For the historically inclined, Archive.org has a complete copy
of `the old Trac Wiki <https://web.archive.org/web/20150929070920/https://www.varnish-cache.org/trac>`__.
The Varnish Book
----------------
Documentation from Varnish Software
-----------------------------------
A comprehensive user guide for System Administrators and Web Developers
in book format provided by \ `Varnish
Software <https://www.varnish-software.com/>`__:
`Varnish Software <https://www.varnish-software.com/>`__ offers
documentation resources which also apply to the FOSS Version:
- `Online Reference Guide for the current stable  release
(4.0) <http://book.varnish-software.com/4.0/>`__
- `Online Reference Guide for version
3.0 <http://book.varnish-software.com/3.0/>`__ (unsupported)
- Get the book as a \ `PDF
download <http://book.varnish-software.com/>`__
`The Varnish Book <https://book.varnish-software.com/>`__
`(& it's GitHub project) <https://github.com/varnish/Varnish-Book/>`__
If you have feedback or want to make improvements to the book please do
so by `creating issues <https://github.com/varnish/Varnish-Book/issues>`__ and/or send
us `pull-requests <https://github.com/varnish/Varnish-Book/pulls>`__.
The Varnish (Web Developer) Wiki
--------------------------------
`Varnish Software <https://www.varnish-software.com/>`__ has compiled a
wiki for Web Developers with Tutorials, Step-by-step guides, tips, VCL
snippets and more. The content focused on the following web technologies:
In the Varnish Software Wiki:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `Wordpress <https://www.varnish-software.com/wiki/content/tutorials/wordpress/index.html>`__
- `Drupal <https://www.varnish-software.com/wiki/content/tutorials/drupal/index.html>`__
......@@ -78,17 +127,11 @@ snippets and more. The content focused on the following web technologies:
- `Adobe Experience Manager <https://www.varnish-software.com/wiki/content/tutorials/aem.html>`__
- `Expression Engine <https://www.varnish-software.com/wiki/content/tutorials/expressionEngine.html>`__
There are also some generic resources available:
- `Varnish Web Developer FAQ <https://www.varnish-software.com/wiki/faq/index.html>`__
- `Getting started with Varnish resources <https://www.varnish-software.com/wiki/start/index.html>`__
- `Using Varnish on any site Guides and Tutorials <https://www.varnish-software.com/wiki/content/tutorials/varnish/index.html>`__
We welcome contributions to the Varnish Web Dev Wiki and you can help by
`creating issues <https://github.com/varnish/Varnish-Wiki/issues>`__ and/or send
us `pull-requests <https://github.com/varnish/Varnish-Wiki/pulls>`__.
- `The Wiki's GitHub project <https://github.com/varnish/Varnish-Wiki/>`__
.. toctree::
:hidden:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment