cvs commit: jakarta-turbine-maven/xdocs repository-upload.xml

[bw...@apache.org]

bwalding    2003/02/13 01:03:09

  Added:       xdocs    repository-upload.xml
  Log:
  o Just a simple doc to give people the general idea behind 
    what it takes to get resources uploaded to ibiblio
  
  Revision  Changes    Path
  1.1                  jakarta-turbine-maven/xdocs/repository-upload.xml
  
  Index: repository-upload.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <author email="bwalding@apache.org">Ben Walding</author>
      <title>Uploading to ibiblio</title>
    </properties>
  
    <body>
      <section name="Overview">
        <p>
          So you want a  resource uploaded to ibiblio?!
        </p>
        
        <p>
          To save time for everybody, here is how you go about it.  
        </p>
      </section>
    
      <section name="Step 1. Resource Template - Mandatory!">
        <p>
          All dependencies require a project file such that Maven can 
          locate and handle meta-information for them.
        </p>
      
        <p>
          The following lists the base minimum information you must
          provide <b>attached</b> to your resource upload request.
        </p>
      
        <p>
          Some requests may be denied due to licensing problems.  
        </p>
          
        <source>
          <![CDATA[
  <project>
    <pomVersion>3</pomVersion>
    <id>[RESOURCE ID HERE]</id>
    <name>[RESOURCE NAME HERE]</name>
    <currentVersion>[RESOURCE VERSION HERE]</currentVersion>
    <organization>
      <name>[RESOURCE OWNER]</name>
      <url>[RESOURCE OWNER SITE]</url>
    </organization>
    <licenses>
      <license>
        <name>[LICENSE NAME HERE]</name>
        <url>[LICENSE LOCATION HERE - Where you got it from!]</url>
        <comments>[Additional comments about the license]</comments>
      </license>
    </license>
  </project>
             ]]>
        </source>
      </section>
    
      <section name="Step 2. Posting the request">
        <p>
          Post your request to the <a href="mail-lists.html">Maven development list</a>.
        </p>  
      
        <p>
          <ol>
            <li>Attach the project descriptor from the previous step</li>  
            <li>Attach a URL of where to pick the resource up from</li>
            <li>Do <b>NOT</b> attach the jar file</li>
            <li>Attach sufficient information for a developer to quickly get access to the jar</li>
            <li>Do not expect the developer to fiddle with build scripts to build the jar.  
              Build it yourself and upload it to a publicly accessible site.</li>
          </ol>  
        </p>
      
      </section>
    
      <section name="Step 3. Patience">
        <p>
          Don't badger people about uploading the resource, there are only a couple of key team members
          who have the accounts to perform this step. They are often busy with work and family.    
        </p>  
      </section>
    </body>
  </document>