The Apache Software Foundation

Create an ASF DOAP File

To be listed on this site, your Apache project must create a DOAP file. The DOAP format is RDF based, so while it is human readable it's primarily meant to be machine read. Creating the file from scratch can be a little intimidating, so this page will allow you to generate an initial file that can then be edited to suit. Alternatively, you can browse the existing projects for one with similar resources and use its DOAP file as a starting point.

Complete the form

Before completing this form you should really read the guidelines. The FAQ page may also prove useful.

Please remember that the data contained in the DOAP file is used directly on the website so please take care when adding content.

Customise your file

The file that is created when you submit your data is only a starting point. You'll likely need to modify some aspects of it, especially adding data that the form doesn't allow you to enter. You should be able to simply copy/paste/edit the sections you need to duplicate.

You may have more than one of the following sections.

  • bug database
  • category
  • download page
  • programming language
  • release
  • repository
  • standard

Validate your file

It is a good idea to check if your DOAP file is at least valid RDF. This can be accomplished using the W3C RDF Validator service. While this won't tell you if your file meets DOAP or Apache guidelines, it is at least a good basic sanity check.

Submitting your file

Your DOAP file should be stored somewhere that is publically accesible. For most projects this will be in their source code repository, but there is no requirement for it to be stored there.

Once you have decided where the file will be stored, send an email to <site-dev at apache.org> so it may be included in the project listings.
Or if you have write access (e.g. you are an ASF member or a PMC chair), you can directly edit the file to get your project listed:
https://svn.apache.org/repos/asf/infrastructure/site-tools/trunk/projects/files.xml
For example, add one of the following entries:

  <location>http://svn.apache.org/repos/asf/httpd/site/trunk/content/doap.rdf</location>
or
  <location>https://git-wip-us.apache.org/repos/asf?p=kafka.git;f=doap_Kafka.rdf;a=blob_plain;hb=HEAD</location>
Please keep the file in alphabetical order by TLP id (i.e. httpd, kafka in the above examples)

Please note: the script to create the projects web-site currently runs every few hours. The output then has to be copied to the public web-servers. This may take a further 24 hours with the current setup of the synchronisation jobs.

DOAP Creation Form

Before completing this form you should really read the guidelines.

When you submit this form a sample file will be created and returned to you. It will be named 'doap_<project>.rdf'. and will be presented as a downloadable file.

Project name Apache
Project homepage http://
Categories info
Programming Languages info
Project PMC
Short Description
Long Description
Bug Database URL
Download Page URL
Mailing Lists Page URL
Release Name
Date (YYYY-MM-DD)
Version
Implemented Standard Title
Body
ID
URL
SVN Repository Location URL
Web View URL
Maintainer Name
Email

Copyright 1999-2014, The Apache Software Foundation

Licensed under the Apache License, Version 2.0.

Generated Wed, 23 Jul 2014 00:30:59 GMT