The Apache Software Foundation

Projects @ Apache Documentation

The data used to generate the website projects.apache.org is maintained by the projects themselves. The code that generates the site is simply using aggregating the data supplied and presenting it in a cohesive manner. The individual projects should never need to be concerned about how the site is generated - they just need to maintain their data!

Guidelines for maintaining their data files can be found here. This section of the website provides more information about how the site is generated and the various dependencies within the data we rely on.

Note that there are two kinds of data files which need to be maintained:

  1. DOAP files (listed in files.xml), which describe the projects. Each project is produced by a PMC: these DOAP files contain a link to the PMC data file,
  2. PMC data files (listed in pmc_list.xml), which describe each PMC itself. This is linked from the DOAP file, and may be used by multiple DOAP files, since one PMC may manage multiple projects.

Note that a basic PMC data file may already be present in the folder https://svn.apache.org/repos/asf/infrastructure/site-tools/trunk/projects/data_files (this is generally set up when the PMC is created. If your PMC file is missing/incorrect, please ask on the site-dev AT apache DOT org mailing list).

ASF Extensions to DOAP

When looking at using DOAP as our file format, we decided that while it met most of our requirments, there were two areas that it didn't have support for. As it's an extensible format, we defined our own extension to DOAP using the 'asfext' namespace. Document making use of one or both of these extensions should use the following namespace declaration:

xmlns:asfext="http://projects.apache.org/ns/asfext#"

The two additions that most projects will need to use are:

  • Project Management Committee
  • Standards

Documentation for both is provided in this section, and guidelines for how they should be used can be found in the DOAP Files section of this website.

Projects Internal Name

In order to standardise the naming for creating links within the projects website, the following format is used for the internal name used as the 'id' attribute for files, PMC files included:

  • lowercase
  • 'Apache ' is removed from front of name
  • spaces are replaced by underscores

e.g. The internal name for 'Apache Forrest' is 'forrest'.

Site Generation Source Code

The source code for DOAP files and the code to generate and manage this projects.apache.org site are stored separately:

Copyright 1999-2015, The Apache Software Foundation

Licensed under the Apache License, Version 2.0.

Generated Mon, 06 Jul 2015 21:30:53 GMT