Manage your project web site
Some notes moved from various documents - please help to enhance...
Please see the instructions of your project or ask the relevant dev@ list for details on how and where your project web site is managed.
It is up to your projects how the website is maintained and what software is used as long as it results in static files that can be served by the our public web servers (limited support for .htaccess files and CGI scripts is also available). The basic requirements for site management are that only committers should be able to modify the site and that notifications of all site changes should be sent to the relevant project mailing lists.
The infrastructure team currently supports two main mechanisms for publishing and maintaining project sites:
- svnpubsub, which allows the static contents of a designated svn
folder (like
.../project/site/public) to automatically published as the project web site athttp://project.apache.org/. The project team can use any site build mechanism it wants as long as the above requirements are met. - Apache CMS, which provides a simple browser-based user interface for editing, staging and publishing site content in Markdown, HTML or any other source format for which support has been added. See the CMS reference for more details. The Apache CMS uses svnpubsub as the underlying mechanism for publishing a site.
Some projects still use a deprecated site deployment system based on periodic synchronization of static files from people.apache.org to the live web servers. This mechanism will be discontinued at the end of 2012, by which time all projects should have migrated to one of the above site publishing mechanisms.
How do I preview my project website?
For svnpubsub sites, review the local files in your svn checkout before committing them. The changes will be published immediately after you commit them.
For CMS sites, just commit the changes (without "publish"-ing them) and browse
to http://TLP.staging.apache.org/. (For example, the staging version of
this page.)
Can I control the configuration of my project website?
Yes, the central config file allows you to use .htaccess files in your
website directories to control configuration. Of course, reading and
parsing an .htaccess file on each request can slow down the server, so
you should consider requesting an adjustment in the central config file for
permanent configuration changes.
How does logging work?
Each day's error and access logs are kept in
www.apache.org:/x1/logs/www/. They are shuffled off each night to a
directory under people.apache.org:/x1/logarchive/ and are then
periodically archived to other media.
No formal log analysis is performed, but you are free to grab the logs and do whatever analysis you would like.
Do project sites have to use the CMS?
No. It's recommended but not required. (More information and reference about the Apache CMS.)
Do project sites have to use svnpubsub?
Yes. Infrastructure will mandate transition to svnpubsub over this year. (svnpubsub technically requires the generated site files to be in a Subversion tree somewhere. For CMS users this tree will be the CMS build output tree.)
Can my project site use its own favicon? We're seeing an Apache Feather.
Yes, just add a favicon.ico file to your site's root. The feather is only
used for project sites that don't have a favicon.ico file.