[Webapps-common-discuss] [commit] r86 - in trunk: . doc

[Sean Finney]

Author: seanius
Date: 2006-05-22 08:51:07 +0000 (Mon, 22 May 2006)
New Revision: 86

Modified:
   trunk/TODO
   trunk/doc/webapps-common.sgml
Log:
more documentation

Modified: trunk/TODO
===================================================================
--- trunk/TODO	2006-05-16 18:23:26 UTC (rev 85)
+++ trunk/TODO	2006-05-22 08:51:07 UTC (rev 86)
@@ -16,6 +16,9 @@
     support from dbconfig-common, and will certainly at the least
 	involve some more thought/planning
 
+- migration paths for previously existing packages which used other
+  methods for configuration.
+
 further ahead:
 
 - there are some tasks which would probably do best to be abstracted into

Modified: trunk/doc/webapps-common.sgml
===================================================================
--- trunk/doc/webapps-common.sgml	2006-05-16 18:23:26 UTC (rev 85)
+++ trunk/doc/webapps-common.sgml	2006-05-22 08:51:07 UTC (rev 86)
@@ -138,6 +138,20 @@
 <chapt id="advanced">Advanced Techniques and Concepts
 	<p> TODO
 
+<chapt id="architecture">For the curious: architecture of webapps-common.
+	<p>
+	the following is a quick reference outline of files and directories
+	that play a part in the functioning of webapps-common.
+	<taglist>
+	<tag><file>/etc/webapps-common/PACKAGE.conf</file>
+	<item>the webapps-common package configuration for PACKAGE.  this file contains the "instance configuration" for a package, or in other words the answers provided for the admin during the debconf-assisted configuration phase. the lines follow the format
+		<example>
+		SERVER/DIRECTORY HTTPD[, HTTPD ...]
+		</example>
+	<tag><file>/etc/webapps-common/apps-available/HTTPD/SITE/PACKAGE_LOCATION.conf</file>
+	<item>web-server-specific configuration files for configured instances.  these are generated from the "instance configuration" file.
+	</taglist>
+
 <chapt id="appendix">Appendix - Variables and Options
 	<sect id="hookvars">Maintainer script hook variables
 	<p>