r5349 - trunk/www

[jcater]

Author: jcater
Date: 2004-03-18 15:08:13 -0600 (Thu, 18 Mar 2004)
New Revision: 5349

Added:
   trunk/www/README
Log:
Added summary for www/ structure

Added: trunk/www/README
===================================================================
--- trunk/www/README    2004-03-18 16:42:44 UTC (rev 5348)
+++ trunk/www/README    2004-03-18 21:08:13 UTC (rev 5349)
@@ -0,0 +1,49 @@
+This repository contains the scripts and source files
+to create GNUe's website.
+
+STRUCTURE
+---------
+The important directories are:
+
+  web/          This directory contains files that are copied directly into
+                the destination directory (/var/www) without any 
pre-processing.
+                Any css styles, images, non-generated php/html files, etc, 
would
+                go into this directory.
+
+  docs/         This directory contains one text file per tool that lists
+                all the documentation available for that tool.
+
+  news/         This directory contains one file per news item. See any given
+                news item to get the format for new news items.
+
+  utils/        This directory contains python scripts used to automate various
+                processes, such as the website creation, etc.
+
+  releases/     This directory contains any release-specific files, such as
+                released READMEs, etc.
+
+  htdig/        This contains templates for htdig. These files are 
pre-processed
+                with php (via the command line) to create a static .html file
+                before being placed in htdig's path.
+
+NEWS ITEMS
+----------
+Note that the news text is processed with ReStructuredText, so
+plan accordingly.
+
+One important issue I've ran across is all lists need one blank line
+before them. So,
+  * Foo
+  * Bar
+
+Would not get processed correctly. This would, though:
+
+  * Foo
+  * Bar
+
+
+Also, if you have two things.
+   Formatted like this.
+
+It treats it as a definition, which we don't want. Include a blank line
+between those two paragraphs.