Added: websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html ============================================================================== --- websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html (added) +++ websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html Wed Aug 24 01:45:44 2011 @@ -0,0 +1,192 @@ + + + + + + + +Website Development + + + + + + + +
+

General

+ +

Community

+ +

Development

+ +

PPMC

+ +

ASF

+ +
+
+ +

Website Development

+

We use Apache Subversion for version control. You can browse our +repository in your web browser.

+

Quick editing of the site is available for committers using the Apache CMS +from your browser.

+

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

+ +

Setup

+

Create a directory on your computer.

+
mkdir odf-site
+cd odf-site
+
+ + +

Download the svn repos for the Odf site.

+
svn co https://svn.apache.org/repos/asf/incubator/odf/site/trunk site
+
+ + +

Download the svn repos for the Apache CMS.

+
svn co https://svn.apache.org/repos/infra/websites/cms/ cms
+
+ + +

Install Python dependencies.

+

Adapted from the Apache CMS Reference

+

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

+
sudo easy_install Pygments
+sudo easy_install ElementTree
+sudo easy_install Markdown
+
+ + +

Directory Layout

+

Content directory

+

The site/content/odftoolkit 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.

+ +

Lib directory

+

The site/lib directory contains two python modules that determine how content files are processed during the site build.

+ +

Build tools

+

You can find the CMS build tools in the cms directory.

+ +

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.

+

Python Markdown Daemon

+

Start the Python Markdown daemon.

+
export MARKDOWN_SOCKET=`pwd`/markdown.socket PYTHONPATH=`pwd`
+python markdownd.py
+
+ + +

Build the site.

+
cms/build/build_site.pl --source-base site --target-base www
+
+ + +

Copy the site to your computer's web server.

+

On my Mac:

+
sudo scp -rp www/content/odftoolkit /Library/WebServer/Documents/.
+
+ + +

The site is then available with http://localhost/odftoolkit/.

+

Submitting your results.

+

Committer

+

Do the appropriate combination of svn status, svn add, and svn commits. Commits will cause staging rebuilds. +See How to Edit the ODF Toolkit Website

+

Contributor

+

(Add instructions on creating patches.)

+

For further information see the Apache Source Code Repository page.

+
+ +
+
+


Powered by the Apache CMS.

+
+
+

+ Apache "ODF Toolkit" is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. + Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and + decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is + not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has + yet to be fully endorsed by the ASF.

+

+ Copyright © 2011 The Apache Software Foundation Licensed under the Apache License, Version 2.0. + Contact Us +
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. +
Other names appearing on the site may be trademarks of their respective owners. +

+
+
+ + +