The Apache Software Foundation

ASF DOAP File FAQ

Q I want to list my project is more than one category but the form to create the DOAP file only lets me select one. Can I add the others? How?
A The form is intended as a simple way to create a DOAP file for a project, it's not intended to be used beyond the initial creation so is limited in its functionality. You can list as many categories or programming languages as you need for a project, provided you include only those listed on the relevant pages.
To add other categories or programming languages simply duplicate the existing entries with the new details.
Q Where should the DOAP file be stored?
A The simple answer is that there are no hard and fast rules about where the file should be stored. It should be in a location that can be accessed via an http or https request, but beyond that there are no restrictions.
Some projects have included the file under the root of their website and provided that URL. They feel this gives them more control over when the file is updated.
Other projects have simply committed the file to their repository and provided a URL to the repository as this way they don't have the concern of publishing the file.
Either is fine and which is right for your project is something you can decide. Remember you can always change the link!
Q Where should the mailing list URL point?
A It should point to a single web page that allows people to find out more information about the mailing lists provided by your project.
Q Where should the repository link point to?
A The repository URL should point at your projects most up to date code, normally known as 'trunk' within the ASF.
Q I need to add more than 'XXX'. How do I do that?
A You'll need to edit the generated DOAP file. Remember the file that is generated is only intended as a starting point for you to adjust. Simply copy the copy section and edit as required.
Q What does the release information mean?
A The release information allows you to add
  • the date of the release
  • a descriptive name for the release
  • a version number
The information is used in various places and combined in various ways, so if you're not sure what to put in the various entries have a look at the generated web pages and RSS feeds to see how your entries will be formatted.
Q How do we get an RSS feed?
A The RSS feeds are generated automatically. You don't need to do anything else.
Q What happens if we commit an error to the DOAP file?
A If the DOAP file can't be processed, for whatever reason, the project will simply not be included on the site.
Once we have greater use of the maintainer information we hope to send an email informing them that there was a problem, but presently that doesn't happen.
Q What date should I use in the 'created' field of a version?
A The date you use should be the date the version was released. This may or may not be the same as the date the tarball was created if this is done prior to the date of the release.

Copyright 1999-2014, The Apache Software Foundation

Licensed under the Apache License, Version 2.0.

Generated Wed, 30 Jul 2014 00:30:39 GMT