Create an ASF DOAP File

Project data now comes from the ASF release catalog. projects.apache.org no longer reads DOAP files. To change your project's name, description, links, categories, languages or releases, edit it in Apache Trusted Releases (releases.apache.org/projects/<key>?tab=metadata; the key is shown in your project page's address) or in the project: metadata: block of your repository's .asf.yaml. An existing DOAP file can still feed ATR via metadata: doap: <url>.

This editor is kept for projects that still want a DOAP file, for example to link from .asf.yaml.

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.

DOAP Creation Form

Before completing this form, you should really read the guidelines.

Already have a published DOAP file?
Starting a new one? Leave this alone and pick your committee in the form below – we'll fill in what we can.

As you fill in the form, your DOAP file is built below it. Copy or download it, then publish it. The suggestions in the right-hand column follow ASF conventions for your PMC and project name; click one to use it.

Project PMC
Project nameApache
Project homepagehttps://
Short Description
Long Description
Repositories
 Git:

SVN:
Categories
Programming Languages
Bug Database URL
or https://issues.apache.org/jira/projects/[JIRA-ID]/
Download Page URL
Mailing Lists Page URL
Releases
Newest first
Implemented Standards

Your DOAP file

This updates as you edit the form. Copy it into doap_projectName.rdf in your project's repository, or download it.


  

     








  
Publish your file

  
Anyone can draft a DOAP file here, but only the project's committers can publish it.
     Not a committer on this project? Send the file to the project's dev@ mailing list
     and they'll take it from there – thank you for helping!


  

  

    
Two steps:

    
    
      
  1. Put the file on your project's website. Commit it to your website source so that it is served at an address like
          https://[committee].apache.org/doap_projectName.rdf.
    
          
    The website is the best place for it: the address won't change when your code repositories are reorganised,
          and it won't be copied into every release tag and branch. Check the address works in a browser before step 2.
    2. 
      
  2. Add it to the projects listing. Add a line to
          data/projects.xml,
          keeping the file in alphabetical order by committee:
    
          
      <location>https://[committee].apache.org/doap_projectName.rdf</location>
    
          
    svn co https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data projects-data
cd projects-data
# edit projects.xml
svn commit -m "Add DOAP file for [project]" projects.xml
    
          
    If you're not comfortable with svn, please contact
          dev@community.apache.org with the address of your file, and we'll add it for you.
    
          
    Your project will appear on this site the next day.
    3. 
    

  






  
Going further

  
The form covers what this site uses. DOAP has a few more elements (for example wiki or
     audience) that you can add by hand; see the DOAP page and the
     guidelines.

  
Checking your file

  
The file generated here is valid RDF. If you edit it by hand, you can check it with the
     W3C RDF Validator. After it's listed, any problems this site
     finds appear on the validation report.