r5084 - trunk/varnish-cache/doc/sphinx/tutorial

perbu at varnish-cache.org perbu at varnish-cache.org
Tue Aug 10 17:38:20 CEST 2010


Author: perbu
Date: 2010-08-10 17:38:20 +0200 (Tue, 10 Aug 2010)
New Revision: 5084

Modified:
   trunk/varnish-cache/doc/sphinx/tutorial/index.rst
Log:
cleaned up the index, must restructure the tutorial some day to balance out the chapters

Modified: trunk/varnish-cache/doc/sphinx/tutorial/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/index.rst	2010-08-10 15:21:42 UTC (rev 5083)
+++ trunk/varnish-cache/doc/sphinx/tutorial/index.rst	2010-08-10 15:38:20 UTC (rev 5084)
@@ -9,63 +9,21 @@
 server and have basic knowledge of the HTTP protocol. The reader
 should have Varnish up and running with the default configuration. 
 
-Good luck.
+The tutorial is split into short chapters, each chapter taking on a
+separate topic. Good luck.
 
-TOC
+.. toctree:: :maxdepth: 1
 
- Getting Varnish Running
-	backend_servers.rst
-        starting_varnish.rst
-	logging.rst
-        sizing_your_cache.rst
-        putting_varnish_on_port_80.rst
- The Varnish Configuration Language
-	vcl.rst
+	backend_servers
+        starting_varnish
+	logging
+        sizing_your_cache
+        putting_varnish_on_port_80
+	vcl
+        statistics
+        increasing_your_hitrate
+	advanced_backend_servers
+        handling_misbehaving_servers
+        advanced_topics
+	troubleshooting
 
- Tuning Varnish
-        increasing_your_hitrate.rst
-	advanced_backend_servers.rst
-        handling_misbehaving_servers.rst
-
- Advanced topics
-        advanced_topics.rst
-
-Troubleshooting and getting help
-	troubleshooting.rst
-
-.. toctree:: 
-
-	backend_servers.rst
-        starting_varnish.rst
-	logging.rst
-        sizing_your_cache.rst
-        putting_varnish_on_port_80.rst
-	vcl.rst
-        statistics.rst
-        increasing_your_hitrate.rst
-	advanced_backend_servers.rst
-        handling_misbehaving_servers.rst
-        advanced_topics.rst
-	troubleshooting.rst
-
-.. todo::
-        starting varnish with -d, seeing a transaction go through
-        explain varnishlog output for a miss and a hit
-        a few simple VCL tricks, including switching VCL on the fly
-        The helpers: varnishstat, varnishhist, varnishtop varnishncsa
-        Now that you know how it works, lets talk planning:
-        - backend, directors and polling
-        - storage
-        - logging
-        - management CLI & security
-        - ESI
-        Real life examples:
-        - A real life varnish explained
-        - A more complex real life varnish explained
-        - Sky's Wikia Setup
-        Varnishtest
-        - What varnishtest does and why
-        - writing simple test-cases
-        - using varnishtest to test your VCL
-        - using varnishtest to reproduce bugs
-




More information about the varnish-commit mailing list