The Apache Software Foundation
Apache Incubator

Overview of the Incubator site

The Incubator website is generated by the Apache CMS, but it is still using the Anakia-based page generation mechanism that was used before, triggered by a CMS external build script.

This means that you can edit the content either directly in svn (and use ant to generate and check the results), or edit via the CMS interface, but final publishing has to be done via the CMS (see below for how).

The source to the Incubator website lives at:

The production documents are kept in the "infra" SVN repository at https://svn.apache.org/repos/infra/websites/production/incubator. That directory is then managed by svnpubsub on the server to re-create the live website.

Edit the content

Help Wanted!

People with commit access to the "incubator" SVN can edit the source documents in the "content" 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 the "content" directory.

Add a new document

Add new documents in the content directories, then do 'svn add'.

Edit your project status page

The sources for the status pages are in content/projects/*.xml

Create Status Page

  1. Copy from the template content/projects/incubation-status-template.xml to content/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 with status "current" to the podlings summary file at content/podlings.xml and ensure that the list of mentors is up-to-date.
  5. Do 'svn update' to be sure you are up-to-date.
  6. Regenerate the documentation by running 'ant' or 'build' 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. The results wil be built to the site-publish directory by default- please look them over, but do not add this directory nor its contents to svn!
  7. svn commit all of the source changes with a good message.
  8. Review your changes via the "commits" mail list.
  9. Wait a minute or two for the CMS to build your changes, then publish them by visiting the Publish site page. See other notes about this step.
This status page is to be kept up to date regularly. This is NOT the same as the 'status report' which is a board report entry in the incubator wiki. You still need to follow your monthly/quarterly status reports

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'.

Review your changes via the "commits" mail list.

To update the website, visit Publish site and fill out the form. Don't forget to give the CMS build system time to build your changes! The CMS provides a page for following the build process.

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.