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

[perbu at varnish-cache.org]

Author: perbu
Date: 2010-05-18 13:06:50 +0200 (Tue, 18 May 2010)
New Revision: 4810

Removed:
   trunk/varnish-cache/doc/sphinx/tutorial/intro.rst
Modified:
   trunk/varnish-cache/doc/sphinx/tutorial/advanced_backend_servers.rst
   trunk/varnish-cache/doc/sphinx/tutorial/increasing_your_hitrate.rst
   trunk/varnish-cache/doc/sphinx/tutorial/index.rst
   trunk/varnish-cache/doc/sphinx/tutorial/statistics.rst
   trunk/varnish-cache/doc/sphinx/tutorial/troubleshooting.rst
   trunk/varnish-cache/doc/sphinx/tutorial/vcl.rst
Log:
Heading cleanups + merged introduction and index

Modified: trunk/varnish-cache/doc/sphinx/tutorial/advanced_backend_servers.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/advanced_backend_servers.rst	2010-05-17 20:11:59 UTC (rev 4809)
+++ trunk/varnish-cache/doc/sphinx/tutorial/advanced_backend_servers.rst	2010-05-18 11:06:50 UTC (rev 4810)
@@ -1,5 +1,5 @@
 Advanced Backend configuration
-==============================
+------------------------------
 
 At some point you might need Varnish to cache content from several
 servers. You might want Varnish to map all the URL into one single

Modified: trunk/varnish-cache/doc/sphinx/tutorial/increasing_your_hitrate.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/increasing_your_hitrate.rst	2010-05-17 20:11:59 UTC (rev 4809)
+++ trunk/varnish-cache/doc/sphinx/tutorial/increasing_your_hitrate.rst	2010-05-18 11:06:50 UTC (rev 4810)
@@ -1,7 +1,7 @@
 .. _tutorial-increasing_your_hitrate:
 
 Achieving a high hitrate
-========================
+------------------------
 
 Now that Varnish is up and running, and you can access your web
 application through Varnish. Unless your application is specifically
@@ -60,6 +60,7 @@
 Headers* and *Firebug* can show you what headers are beeing sent and
 recieved.
 
+
 HTTP Headers
 ------------
 

Modified: trunk/varnish-cache/doc/sphinx/tutorial/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/index.rst	2010-05-17 20:11:59 UTC (rev 4809)
+++ trunk/varnish-cache/doc/sphinx/tutorial/index.rst	2010-05-18 11:06:50 UTC (rev 4810)
@@ -4,9 +4,24 @@
 Varnish Tutorial
 %%%%%%%%%%%%%%%%
 
-.. toctree::
+Varnish is a web accelerator. It is installed in frond of your web
+application and it caches the reponses, making your web site run  Varnish
+is fast, flexible and easy to use.
 
-	intro.rst
+This tutorial does not go through every bit of functionality Varnish
+has. It will give you a good overview of what Varnish does and how it
+is done.
+
+We assume you have a web server and a web application up and running
+and that you want to accelerate this application with Varnish.
+
+Furthermore we assume you have read the :ref:`Installation` and that
+it is installed with the default configuration.
+
+
+
+.. toctree:: 
+
 	backend_servers.rst
         starting_varnish.rst
 	logging.rst

Deleted: trunk/varnish-cache/doc/sphinx/tutorial/intro.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/intro.rst	2010-05-17 20:11:59 UTC (rev 4809)
+++ trunk/varnish-cache/doc/sphinx/tutorial/intro.rst	2010-05-18 11:06:50 UTC (rev 4810)
@@ -1,21 +0,0 @@
-%%%%%%%%%%%%
-Introduction
-%%%%%%%%%%%%
-
-Varnish is a web accelerator. It is installed in frond of your web
-application and it caches the reponses, making your web site run  Varnish
-is fast, flexible and easy to use.
-
-This tutorial does not go through every bit of functionality Varnish
-has. It will give you a good overview of what Varnish does and how it
-is done.
-
-We assume you have a web server and a web application up and running
-and that you want to accelerate this application with Varnish.
-
-Furthermore we assume you have read the :ref:`Installation` and that
-it is installed with the default configuration.
-
-
-
-

Modified: trunk/varnish-cache/doc/sphinx/tutorial/statistics.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/statistics.rst	2010-05-17 20:11:59 UTC (rev 4809)
+++ trunk/varnish-cache/doc/sphinx/tutorial/statistics.rst	2010-05-18 11:06:50 UTC (rev 4810)
@@ -8,7 +8,7 @@
 doing. There are several tools that can help.
 
 varnishtop
-==========
+~~~~~~~~~~
 
 The varnishtop utility reads the shared memory logs and presents a
 continuously updated list of the most commonly occurring log entries.
@@ -24,7 +24,7 @@
 the client are sendning you.
 
 varnishhist
-===========
+~~~~~~~~~~~
 
 The varnishhist utility reads varnishd(1) shared memory logs and
 presents a continuously updated histogram showing the distribution of
@@ -35,7 +35,7 @@
 
 
 varnishsizes
-============
+~~~~~~~~~~~~
 
 Varnishsizes does the same as varnishhist, except it shows the size of
 the objects and not the time take to complete the request. This gives
@@ -43,7 +43,7 @@
 
 
 varnishstat
-===========
+~~~~~~~~~~~
 
 Varnish has lots of counters. We count misses, hits, information about
 the storage, threads created, deleted objects. Just about

Modified: trunk/varnish-cache/doc/sphinx/tutorial/troubleshooting.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/troubleshooting.rst	2010-05-17 20:11:59 UTC (rev 4809)
+++ trunk/varnish-cache/doc/sphinx/tutorial/troubleshooting.rst	2010-05-18 11:06:50 UTC (rev 4810)
@@ -1,9 +1,9 @@
 Troubleshooting Varnish
-=======================
+-----------------------
 
 
 When Varnish won't start
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sometimes Varnish wont start. There is a pletphora of reasons why
 Varnish wont start on your machine. We've seen everything from wrong
@@ -45,6 +45,6 @@
 
 
 Varnish is crashing
--------------------
+~~~~~~~~~~~~~~~~~~~
 
 When varnish goes bust.

Modified: trunk/varnish-cache/doc/sphinx/tutorial/vcl.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/vcl.rst	2010-05-17 20:11:59 UTC (rev 4809)
+++ trunk/varnish-cache/doc/sphinx/tutorial/vcl.rst	2010-05-18 11:06:50 UTC (rev 4810)
@@ -1,7 +1,4 @@
 Varnish Configuration Language - VCL
-====================================
-
-How ordinary configuration files work
 -------------------------------------
 
 Varnish has a really neat configuration system. Most other systems use
@@ -27,9 +24,6 @@
    the first? Or does Squid try to combine all the matching rules. I
    actually don't know. 
 
-Enter VCL
----------
-
 Now enter Varnish. Varnish takes your configuration file and
 translates it to C code, then runs it through a compiler and loads
 it. When requests come along varnish just executes the relevant