Return-Path: X-Original-To: apmail-incubator-ooo-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-ooo-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id DC85E639D for ; Sun, 10 Jul 2011 21:42:51 +0000 (UTC) Received: (qmail 3985 invoked by uid 500); 10 Jul 2011 21:42:51 -0000 Delivered-To: apmail-incubator-ooo-commits-archive@incubator.apache.org Received: (qmail 3917 invoked by uid 500); 10 Jul 2011 21:42:51 -0000 Mailing-List: contact ooo-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: ooo-dev@incubator.apache.org Delivered-To: mailing list ooo-commits@incubator.apache.org Received: (qmail 3910 invoked by uid 99); 10 Jul 2011 21:42:51 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 10 Jul 2011 21:42:51 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 10 Jul 2011 21:42:48 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 3281623888FE for ; Sun, 10 Jul 2011 21:42:27 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r792497 - in /websites/production/openofficeorg: ./ content/openofficeorg/website-local.html Date: Sun, 10 Jul 2011 21:42:27 -0000 To: ooo-commits@incubator.apache.org From: wave@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110710214227.3281623888FE@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: wave Date: Sun Jul 10 21:42:26 2011 New Revision: 792497 Log: AAdded a directory layout section to website-local.html Modified: websites/production/openofficeorg/ (props changed) websites/production/openofficeorg/content/openofficeorg/website-local.html Propchange: websites/production/openofficeorg/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Sun Jul 10 21:42:26 2011 @@ -1 +1 @@ -/websites/staging/openofficeorg/trunk:791146-792493 +/websites/staging/openofficeorg/trunk:791146-792496 Modified: websites/production/openofficeorg/content/openofficeorg/website-local.html ============================================================================== --- websites/production/openofficeorg/content/openofficeorg/website-local.html (original) +++ websites/production/openofficeorg/content/openofficeorg/website-local.html Sun Jul 10 21:42:26 2011 @@ -79,6 +79,7 @@ repository in your web browser.

This page gives instructions on doing website development on your local computer.

Setup - How to download the OOo project site repos and setup the Apache CMS.
Directory Layout - Where to find the content, templates, and scripts.
Local Development - How to build and test locally.
Submitting Your Results - How to contribute your edits.

@@ -101,20 +102,43 @@ repository in your web browser.

Install Python dependencies.

Adapted from the Apache CMS Reference

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.

Install dependencies

Follow the installation instructions for setuptools.

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

Using your favorite editors edit the site content, templates, and lib scripts.