Making updates to the Apache OpenOffice project's websites is simple. It's even easy for non-committers (new contributors - like you) to create a patch to request that pages are updated by the project community.
The Apache OpenOffice project maintains two websites:
Both of these sites use the Apache Content Management System (CMS) to manage editing, submitting changes, and updating the live websites. In essence, regardless of how you make changes to either web area, the changes first go the staging sites for these areas, respectively (below), and then are copied to the production websites.
Additionally, the project website uses Markdown syntax for page contents. The "legacy" OpenOffice.org site uses html.
You can make changes to either site using svn (subversion). This typically involves doing an svn checkout, making changes to files and then either committing your changes if you are an "Apache committer", or submitting a "patch" (an svn "diff" file) if you are a contributor but not a "committer". Consult your local svn implementation for how to do commits or create patches. (See also, the SVN Book ). Patches can be submitted as attachments to e-mail to the Apache OpenOffice developer list.
SVN commits will commit your changes to the "staging area". you will need to "publish" your changes to make them active on the "production" site.
Quick editing of the site is available for committers and contributors using the Apache CMS from your browser. If you are a committer and use the bookmarklet in your web browser, you should use your Apache credentials to log in, make changes and submit them to staging. If you are not a committer, you can still use the bookmarklet by signing in to the bookmarklet as anonymous. See detailed how-to steps in the Apache CMS Reference for non-committers.
As previously noted, changes you make, either through an svn commit or using the CMS GUI tool, are enacted on the staging sites. Once you review your changes on the staging site, you can "publish" the site -- enacting our changes on the production site. Only Apache "committers" can actually publish sites.
Generally speaking, unless you have established a full Complete Local Development environment as described in the next section, you will likely be running publish.pl from your "people.apache.org" account.
If you are not a committer, you will need to follow the procedures for "contributors" in the Developer FAQ for getting your changes published by a committer of the project, after you submit a patch.
The following information provides instructions on doing website development on your local computer. These instructions assume you have setup a webserver in your local environment. Details are provided on setting up the resources needed to process "Markdown" on your local server and how to publish to the production Apache OpenOffice sites from your local environment.
site and the migrating openoffice.org website.
mkdir aoo-web cd aoo-web
svn co https://svn.apache.org/repos/asf/openoffice/site/trunk site
svn co https://svn.apache.org/repos/asf/openoffice/ooo-site/trunk ooo-site
svn co https://svn.apache.org/repos/infra/websites/cms/ cms
You will have three sub-directories in your local website directory -
Adapted from the Apache CMS Reference
The easiest way to install the dependencies is to use Python setuptools.
sudo easy_install Pygments sudo easy_install ElementTree sudo easy_install Markdown
ooo-site/lib/path.pm are copied as is to the web site during the build.
ooo-site/templates directories contain the html skeletons used during the site build.
skeleton.html- our current html page template.
sidenav.mdtext- markdown of the side navigation panel.
html_page.html- wrapping for html pages.
single_narrative.html- extends skeleton.html.
ooo-site/lib directories contain two perl 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 cms/build/markdownd.py
cms/build/build_site.pl --source-base site --target-base www cms/build/build_site.pl --source-base ooo-site --target-base www
On my Mac:
sudo scp -rp www/content /Library/WebServer/Documents/.
Do the appropriate combination of svn status, svn add, and svn commits. Commits will cause staging rebuilds. See How to Edit the Apache OpenOffice Website
Please note that if you have removed any files or directories from your source tree then you must also remove
these from the staging build. The staging for the project site is
https://svn.apache.org/repos/infra/websites/staging/openofficeorg. Check the staging builf out,
svn remove and commit the same files and directories.
Use SVN to submit svn "diffs".
For further information see the Apache Source Code Repository page.
We use Google Analytics on key webpages to gather information on website usage patterns. This information is then used to help us prioritize what areas of the website should get more attention.
Note: This is not needed for the project website, only for the openoffice.org pages.
It is not necessary to add this to every single web page. The greatest benefit for the effort comes from adding it to the key destination pages.