svn commit: r1144967 - /incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext

[wa...@apache.org]

Author: wave
Date: Sun Jul 10 21:41:27 2011
New Revision: 1144967

URL: http://svn.apache.org/viewvc?rev=1144967&view=rev
Log:
Added a directory layout section to website-local.mdtext

Modified:
    incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext

Modified: incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext
URL: http://svn.apache.org/viewvc/incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext?rev=1144967&r1=1144966&r2=1144967&view=diff
==============================================================================
--- incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext (original)
+++ incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext Sun Jul 10 21:41:27 2011
@@ -25,6 +25,7 @@ Quick editing of the site is available f
 This page gives instructions on doing website development on your local computer.
 
 * [Setup](#setup) - How to download the OOo project site repos and setup the Apache CMS.
+* [Directory Layout](#directory_layout) - Where to find the content, templates, and scripts.
 * [Local Development](#local_development) - How to build and test locally.
 * [Submitting Your Results](#submitting_your_results) - How to contribute your edits.
 
@@ -48,19 +49,50 @@ This page gives instructions on doing we
 
 Adapted from the [Apache CMS Reference][3]
 
-The easiest easiest way to install the dependencies is to use Python setuptools.
-Check your version of Python
+The easiest way to install the dependencies is to use Python setuptools.
+
+#### Check your version of Python
 
     python --version
 
-Follow the installation instructions for [setuptools][4].
+#### Follow the installation instructions for [setuptools][4].
 
-Install dependencies
+#### Install dependencies
 
     sudo easy_install Pygments
     sudo easy_install ElementTree
     sudo easy_install Markdown
 
+## Directory Layout
+
+#### Content directory
+
+The `site/content/openofficeorg` directory contains web content - markdown, html, javascript, css, images and other files. Files that do not fit recognized patterns from `site/lib/path.pm` are copied as is to the web site during the build.
+
+#### Templates directory
+
+The `site/templates` directory contains the html skeletons used during the site build.
+
+* `skeleton.html` - our current html page template.
+* `sidenav.mdtext` - markdown of the side navigation panel.
+
+#### Lib directory
+
+The `site/lib` directory contains two python modules that determine how content files are processed during the site build.
+
+* `path.pm` - maps file patterns like `.mdtext` into the view building routines. We can expand to cover other patterns.
+* `view.pm` - a set of python subroutines for converting content into web pages.
+
+#### Build tools
+
+You can find the CMS build tools in the `cms` directory.
+
+* `cms/build/` - perl scripts for building the site and markdown extensions.
+* `cms/conversion-utilities/` - scripts used by various projects for conversion including `cwiki` conversion.
+* `cms/webgui/` - the webgui behind the `bookmarklet`.
+
+These can be extended locally. Before any changes become part of our process they will need to be cleared with Apache Infrastructure. We'll need to submit patches. These should be additive or be bug fixes.
+
 ## Local Development
 
 ### Edit the site