The Apache Software Foundation Apache Incubator

Overview of the Incubator site

The source to the Incubator website lives at:

The top-level Incubator website is currently generated by Apache Velocity Anakia

This is the same setup as used by the main www.apache.org site. You may find the main apache.org site help page and site README of use. Note that there are some minor differences between the main apache.org site and the incubator site (namely that xdocs becomes site-author and docs becomes site-publish).

The source documents are kept in the "incubator" SVN repository at "site-author". The status reports for each project are in site-author/project/

The production documents are kept in the "incubator" SVN repository at "site-publish". That directory is then checked-out on the server to re-create the website.

Edit the content

People with commit access to the "incubator" SVN can edit the source documents in the "site-author" directory. That is any ASF Member and any committer on a current podling in incubation. So you can all help to keep your project's Status page up-to-date, and if you find problems with the "guidelines" docs then can immediately fix them. If unsure, then discuss changes on the general mailing list. Note that the "policy" documents need special treatment.

Anyone else can send patches to those documents to the INCUBATOR issue tracker.

Checkout the Incubator SVN site

svn co http://svn.apache.org/repos/asf/incubator/public/trunk incubator
cd incubator
If you are a committer and intending to commit your changes, please ensure you use https instead of http.

Edit the source documents

The source content is in Anakia xdoc format at "site-author" directory.

Add a new document

Add new documents in the site-author directories, then do 'svn add'. If your new documents need to be navigable from the left-hand side menu, then add a new entry to the site-author/stylesheets/project.xml file in the "projects" element (yes, sorry, it is a hangover from an old configuration).

If you are adding a new podling, then see the steps in the following section.

Edit your project status report

The sources for the status reports are in site-author/projects/*.xml

Create Status Report

  1. Copy from the template site-author/projects/incubation-status-template.xml to site-author/projects/${project}.xml then 'svn add'
  2. The copied template contains customization instructions. Follow them.
  3. Go through the template actions. Delete any which are not relevant and mark as completed any actions which are already done.
  4. Add an entry to the table at site-author/projects/index.xml
  5. Add an entry to the right-hand menu at site-author/stylesheets/project.xml in the "menu" element.
  6. Do 'svn update' to be sure you are up-to-date.
  7. Regenerate the documentation by running 'ant' from the top-level. See more detail about this process in the following section. Note that there will be many output changes because a new entry has been added to the right-hand menu which is replicated on every page.
  8. svn add the generated status report site-publish/projects/${project}.html
  9. svn commit all the changes with a good message
  10. Update the copy in the staging directory /www/incubator.apache.org. It may take a few hours before the live website is sync'd. See other notes about this step.

Generating the top-level website

Please generate the website yourself and check in the changes. If you have any problems, ask for help on the Incubator's general list.

In the top-level "incubator" SVN directory, do 'ant' to render the HTML files into the "site-publish" directory. (If you don't have ant installed, you can run build.sh or build.bat instead.) If the site built without errors, then do the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'.

To update the website, the "incubator/site-publish" SVN directory is checked-out on the apache.org web server.

ssh people.apache.org
cd /www/incubator.apache.org
svn update

Other notes

Make sure that your subversion client is properly configured.

See other notes for maintenance of apache.org project websites.

If you are still having trouble committing, then perhaps the Subversion authorization is not yet properly configured to enable your group's access.