commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Niall Pemberton <niall.pember...@gmail.com>
Subject Re: svn commit: r922687 - /commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml
Date Sat, 13 Mar 2010 23:46:55 GMT
On Sat, Mar 13, 2010 at 11:38 PM, Adrian Crum <adrian.crum@yahoo.com> wrote:
> That's a great idea! It will really help newcomers.

:) sorry it wasn't there for you :(

Niall

> -Adrian
>
> --- On Sat, 3/13/10, niallp@apache.org <niallp@apache.org> wrote:
>
>> From: niallp@apache.org <niallp@apache.org>
>> Subject: svn commit: r922687 - /commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml
>> To: commits@commons.apache.org
>> Date: Saturday, March 13, 2010, 3:10 PM
>> Author: niallp
>> Date: Sat Mar 13 23:10:02 2010
>> New Revision: 922687
>>
>> URL: http://svn.apache.org/viewvc?rev=922687&view=rev
>> Log:
>> Add a page on setting up a new sandbox component
>>
>> Added:
>>
>> commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml   (with
>> props)
>>
>> Added:
>> commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml
>> URL: http://svn.apache.org/viewvc/commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml?rev=922687&view=auto
>> ==============================================================================
>> ---
>> commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml
>> (added)
>> +++
>> commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml
>> Sat Mar 13 23:10:02 2010
>> @@ -0,0 +1,176 @@
>> +<?xml version="1.0"?>
>> +<!--
>> + Licensed to the Apache Software Foundation (ASF) under
>> one or more
>> + contributor license agreements.  See the NOTICE file
>> distributed with
>> + this work for additional information regarding copyright
>> ownership.
>> + The ASF licenses this file to You under the Apache
>> License, Version 2.0
>> + (the "License"); you may not use this file except in
>> compliance with
>> + the License.  You may obtain a copy of the License
>> at
>> +
>> +      http://www.apache.org/licenses/LICENSE-2.0
>> +
>> + Unless required by applicable law or agreed to in
>> writing, software
>> + distributed under the License is distributed on an "AS
>> IS" BASIS,
>> + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
>> express or implied.
>> + See the License for the specific language governing
>> permissions and
>> + limitations under the License.
>> +-->
>> +
>> +<document>
>> +
>> + <properties>
>> +  <title>Adding a new Sandbox
>> component</title>
>> + </properties>
>> +
>> +  <body>
>> +
>> +    <section name="Adding a new Sandbox
>> component">
>> +
>> +      <p>
>> +        This page describes the steps
>> to setup a new <a href="sandbox/index.html">Sandbox
>> Component</a>
>> +        using component
>> <strong>foo</strong> as an example.
>> +      </p>
>> +
>> +      <subsection name="Subversion
>> Repository">
>> +        <p>
>> +          <strong>Create
>> the Repository</strong><br />
>> +          Create the
>> <em>foo</em> repository in
>> +          <a href="https://svn.apache.org/repos/asf/commons/sandbox/">https://svn.apache.org/repos/asf/commons/sandbox/</a>
>> +          with the usual folder
>> structure:
>> +        </p>
>> +
>> +        <source>
>> +          foo
>> +           |
>> +           +--branches
>> +           |
>> +           +--tags
>> +           |
>> +           +--trunk
>> +        </source>
>> +
>> +        <p>
>> +          <strong>Add the
>> component to
>> <code>trunks-sandbox</code></strong><br
>> />
>> +          <a href="https://svn.apache.org/repos/asf/commons/trunks-sandbox/">trunks-sandbox</a>
>> +          uses subversion a
>> <code>svn:externals</code> property to link to
>> the <i>trunks</i> of all the sandbox compoenent
>> - update the
>> +
>> <code>svn:externals</code> property for <a
>> href="https://svn.apache.org/repos/asf/commons/trunks-sandbox/">trunks-sandbox</a>
>> +          to include the new
>> Sandbox component:
>> +        </p>
>> +
>> +        <source>
>> +          foo https://svn.apache.org/repos/asf/commons/sandbox/foo/trunk
>> +        </source>
>> +
>> +        <p>
>> +          <strong>Copying
>> the code</strong><br />
>> +          If the code is being
>> brought to the <a href="sandbox/index.html">Commons
>> Sandbix</a> from elsewhere at the
>> +          <a href="http://www.apache.org/">ASF</a> then please
do
>> a <i>subversion cop</i> so that the history of
>> +          the code is retained.
>> +        </p>
>> +
>> +      </subsection>
>> +
>> +      <subsection name="Create the
>> project structure">
>> +        <p>
>> +          Commons components use
>> <a href="http://maven.apache.org/">Maven</a> as their
>> primary build system and
>> +          it is recommended that
>> the project adopts the default Maven structure:
>> +        </p>
>> +        <source>
>> +          trunk
>> +           |
>> +
>>    +--NOTICE.txt
>> +
>>    +--LICENSE.txt
>> +           +--pom.xml
>> +           +--trunk
>> +           +--src
>> +
>>    +--main
>> +
>>    |    |
>> +
>>    |    +--java
>> +
>>    |    +--resources
>> +
>>    |
>> +
>>    +--test
>> +
>>    |    |
>> +
>>    |    +--java
>> +
>>    |
>> +
>>    +--site
>> +
>>     |
>> +
>>     +--site.xml
>> +
>>     +--resources
>> +
>>     |      |
>> +
>>     |      +--images
>> +
>>     |
>> +
>>     +--xdoc
>> +
>>          |
>> +
>>          +--index.xml
>> +        </source>
>> +
>> +        <p>
>> +          See <a href="http://svn.apache.org/repos/asf/commons/sandbox/test-maven/sample-sandbox-project/">here</a>
>> +          for a sample Sandbox
>> project.
>> +        </p>
>> +      </subsection>
>> +
>> +      <subsection name="Using
>> Maven">
>> +
>> +        <p>
>> +          if you're new to <a
>> href="http://maven.apache.org/">Maven</a>, here are
>> some useful links to get started:
>> +        </p>
>> +        <ul>
>> +          <li><a
>> href="http://maven.apache.org/download.html">Download
>> Maven</a></li>
>> +          <li><a
>> href="http://maven.apache.org/download.html#Installation">Installation
>> Instructions</a></li>
>> +          <li><a
>> href="http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html">Maven
>> in 5 Minutes</a></li>
>> +        </ul>
>> +        <p>
>> +          Once you have installed
>> maven the following commands are useful:
>> +        </p>
>> +        <source><![CDATA[
>> +          mvn clean
>>           <!-- clean the project
>> -->
>> +          mvn test
>>            <!--
>> compile and run the tests -->
>> +          mvn package
>>           <!-- compile, run
>> tests and create the jar -->
>> +          mvn site
>>            <!-- create
>> the component site -->
>> +        ]]></source>
>> +
>> +      </subsection>
>> +
>> +      <subsection name="Setup a Maven
>> pom.xml">
>> +        <p>
>> +          There is a <a
>> href="http://svn.apache.org/repos/asf/commons/sandbox/test-maven/sample-sandbox-project/trunk/pom.xml">sample
>> pom.xml</a>
>> +          in the <a href="http://svn.apache.org/repos/asf/commons/sandbox/test-maven/sample-sandbox-project/">sample
>> project</a>
>> +          mentioned above.
>> +        </p>
>> +        <p>
>> +          Sandbox projects use
>> the
>> +          in the <a href="http://svn.apache.org/repos/asf/commons/proper/commons-sandbox-parent/trunk/pom.xml">commons-sandbox-parent</a>
>> +          pom.xml as there
>> parent, which in turn has the
>> +          <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/pom.xml">commons-parent</a>
>> as its parent.
>> +          There are notes on what
>> the commons-parent pom <a
>> href="commons-parent-pom.html">here</a>.
>> +        </p>
>> +      </subsection>
>> +
>> +      <subsection name="Create a SANDBOX
>> JIRA component">
>> +
>> +        <p>
>> +          There is a single JIRA
>> projects for all <a
>> href="sandbox/index.html">Sandbox</a>
>> +          components:
>> +        </p>
>> +
>> +        <p>
>> +          <a href="http://issues.apache.org/jira/browse/SANDBOX">http://issues.apache.org/jira/browse/SANDBOX</a>
>> +        </p>
>> +
>> +        <ul>
>> +          <li>Create a new
>> component in JIRA, making a note of the
>> <code>componentid</code></li>
>> +          <li>Set
>> <code>commons.jira.componentid</code> property
>> in the component's pom.xml to to the
>> <code>componentid</code></li>
>> +          <li>Run the
>> following command in your new Sandbox project to create a
>> custom issue tracking page:</li>
>> +        </ul>
>> +
>> +        <source>
>> +          mvn
>> commons:sandbox-jira-page
>> +        </source>
>> +
>> +      </subsection>
>> +
>> +    </section>
>> +
>> +  </body>
>> +</document>
>>
>> Propchange:
>> commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml
>> ------------------------------------------------------------------------------
>>     svn:eol-style = native
>>
>> Propchange:
>> commons/proper/commons-site/src/site/xdoc/new-sandbox-component.xml
>> ------------------------------------------------------------------------------
>>     svn:keywords = Date Author Id Revision
>> HeadURL
>>
>>
>>
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message