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 @@ + + ++ + + + +
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.+
mkdir odf-site +cd odf-site +
svn co https://svn.apache.org/repos/asf/incubator/odf/site/trunk site +
svn co https://svn.apache.org/repos/infra/websites/cms/ cms +
Adapted from the Apache CMS Reference+
The easiest way to install the dependencies is to use Python setuptools.+
python --version +
sudo easy_install Pygments +sudo easy_install ElementTree +sudo easy_install Markdown +
site/lib/path.pm are copied as is to the web site during the build.
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.
site/lib directory contains two python modules that determine how content files are processed during the site build.
path.pm- maps file patterns like
.mdtextinto the view building routines. We can expand to cover other patterns.
view.pm- a set of python subroutines for converting content into web pages.
You can find the CMS build tools in the
cms/build/- perl scripts for building the site and markdown extensions.
cms/conversion-utilities/- scripts used by various projects for conversion including
cms/webgui/- the webgui behind the
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.+
Using your favorite editors edit the site content, templates, and lib scripts.+
Start the Python Markdown daemon.+
export MARKDOWN_SOCKET=`pwd`/markdown.socket PYTHONPATH=`pwd` +python markdownd.py +
cms/build/build_site.pl --source-base site --target-base www +
On my Mac:+
sudo scp -rp www/content/odftoolkit /Library/WebServer/Documents/. +
The site is then available with http://localhost/odftoolkit/.+
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+
(Add instructions on creating patches.)+
For further information see the Apache Source Code Repository page.+