Author: brett Date: Mon Oct 31 21:23:16 2005 New Revision: 329977 URL: http://svn.apache.org/viewcvs?rev=329977&view=rev Log: convert some docs
Added: maven/components/trunk/maven-site/src/site/xdoc/developers/code-style.xml - copied unchanged from r327959, maven/maven-1/core/trunk/xdocs/developers/code-style.xml Modified: maven/components/trunk/maven-site/src/site/apt/helping.apt maven/components/trunk/maven-site/src/site/apt/patches.apt maven/components/trunk/maven-site/src/site/apt/where-is-it.apt maven/components/trunk/maven-site/src/site/site.xml Modified: maven/components/trunk/maven-site/src/site/apt/helping.apt URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/helping.apt?rev=329977&r1=329976&r2=329977&view=diff ============================================================================== --- maven/components/trunk/maven-site/src/site/apt/helping.apt (original) +++ maven/components/trunk/maven-site/src/site/apt/helping.apt Mon Oct 31 21:23:16 2005 @@ -1,68 +1,43 @@ -<?xml version="1.0"?> -<!-- -/* - * Copyright 2001-2005 The Apache Software Foundation. - * - * Licensed 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> - <author email="[EMAIL PROTECTED]">Brett Porter</author> - <title>How to Help</title> - </properties> - - <body> - <section name="How to Help"> - <p> - As with any open source project, there are several ways you can help: - </p> - <ul> - <li>Join the <a href="../mail-lists.html">mailing list</a> and answer other user's questions</li> - <li>Report bugs, feature requests and other issues in the <a href="../issue-tracking.html">issue tracking</a> - application.</li> - <li><a href="patches.html">Submit patches</a> to reported issues (both those you find, or that others have - filed)</li> - </ul> - <p> - Your participation in the community is much appreciated! - </p> - </section> - <section name="Why Would I Want to Help?"> - <p> - There are several reasons these are good things. - </p> - <ul> - <li>By answering other people's questions, you can learn more for yourself</li> - <li>By submitting your own fixes, they get incorporated faster</li> - <li>By reporting issues, you ensure that bugs don't get missed, or forgotten</li> - <li>You are giving back to a community that has given you software for free</li> - </ul> - </section> - <section name="How do I Join the Project?"> - <p> - Projects at Apache operate under a meritocracy, meaning those that the developers notice participating to a - high extent will be invited to join the project as a committer. - </p> - <p> - This is as much based on personality and ability to work with other developers and the community as it is with - proven technical ability. Being unhelpful to other users, or obviously looking to become a committer for bragging - rights and nothing else is frowned upon, as is asking to be made a committer without having contributed - sufficiently to be invited. - </p> - </section> - </body> -</document> + ----- +How to Help + ----- +Brett Porter + ------ +1 November 2005 + ----- + +How to Help + + As with any open source project, there are several ways you can help: + + * Join the {{{mail-lists.html} mailing list}} and answer other user's questions + + * Report bugs, feature requests and other issues in the {{{issue-tracking.html} issue tracking}} application. + + * {{{patches.html} Submit patches}} to reported issues (both those you find, or that others have filed) + + Your participation in the community is much appreciated! + +Why Would I Want to Help? + + There are several reasons that are good things. + + * By answering other people's questions, you can learn more for yourself + + * By submitting your own fixes, they get incorporated faster + + * By reporting issues, you ensure that bugs don't get missed, or forgotten + + * You are giving back to a community that has given you software for free + +How do I Join the Project? + + Projects at Apache operate under a meritocracy, meaning those that the developers notice participating to a + high extent will be invited to join the project as a committer. + + This is as much based on personality and ability to work with other developers and the community as it is with + proven technical ability. Being unhelpful to other users, or obviously looking to become a committer for bragging + rights and nothing else is frowned upon, as is asking to be made a committer without having contributed + sufficiently to be invited. + Modified: maven/components/trunk/maven-site/src/site/apt/patches.apt URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/patches.apt?rev=329977&r1=329976&r2=329977&view=diff ============================================================================== --- maven/components/trunk/maven-site/src/site/apt/patches.apt (original) +++ maven/components/trunk/maven-site/src/site/apt/patches.apt Mon Oct 31 21:23:16 2005 @@ -1,61 +1,37 @@ -<?xml version="1.0"?> -<!-- -/* - * Copyright 2001-2005 The Apache Software Foundation. - * - * Licensed 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> - <author email="[EMAIL PROTECTED]">Brett Porter</author> - <title>Submitting Patches</title> - </properties> - - <body> - <section name="How to Submit a Patch"> - <p> - When you fix a bug in the Maven source code, you will submit a patch to the <a href="../issue-tracking.html">issue tracking system</a> for developers to apply. - </p> - <p> - First, if this is a new issue of your own that is being fixed, ensure that the issue is actually in the issue - tracking system. Look for an existing one, and if it is not found, create a new one. - </p> - <p> - Ensure that you have done a full update from source control recently, and have tested your changes. If it is a - new feature or changes the bevahiour of something, make sure to update the relevant documentation. You may - even like to add a <code>changes.xml</code> item describing your change, the issue, and who you are in the - <code>due-to="Your Name"</code> attribute. - </p> - <p> - You should use the Maven code style for your contributions, and be careful to limit changes only to the - relevant areas of the submission. Some <a href="../developers/code-style.html">code style descriptors</a> - for different IDEs are also available. - </p> - <p> - Make sure any new files you've created that you want to add have had <code>svn add</code> run on them first. - </p> - <p> - Prepare the patch by going to the top level of the checkout (the <code>trunk</code>), and running: - </p> - <source>svn diff >ISSUE-NUMBER.txt</source> - <p> - Replace ISSUE-NUMBER in the filename with the actual ticket number in the issue tracking system. - Finally, attach the file to the issue tracking system as an attachment. - </p> - </section> - </body> -</document> + ----- +Submitting Patches + ----- +Brett Porter + ------ +1 November 2005 + ----- + +How to Submit a Patch + + When you fix a bug in the Maven source code, you will submit a patch to the {{{issue-tracking.html} issue tracking + system}} for developers to apply. + + First, if this is a new issue of your own that is being fixed, ensure that the issue is actually in the issue + tracking system. Look for an existing one, and if it is not found, create a new one. + + Ensure that you have done a full update from source control recently, and have tested your changes. If it is a + new feature or changes the bevahiour of something, make sure to update the relevant documentation. You may + even like to add a <<<changes.xml>>> item describing your change, the issue, and who you are in the + <<<due-to="Your Name">>> attribute. + + You should use the Maven code style for your contributions, and be careful to limit changes only to the + relevant areas of the submission. Some {{{developers/code-style.html} code style descriptors}}. + for different IDEs are also available. + + Make sure any new files you've created that you want to add have had <<<svn add>>> run on them first. + + Prepare the patch by going to the top level of the checkout (the <<<trunk>>>), and running: + +------ +svn diff >ISSUE-NUMBER.txt +------ + + Replace ISSUE-NUMBER in the filename with the actual ticket number in the issue tracking system. + Finally, attach the file to the issue tracking system as an attachment. + Modified: maven/components/trunk/maven-site/src/site/apt/where-is-it.apt URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/where-is-it.apt?rev=329977&r1=329976&r2=329977&view=diff ============================================================================== --- maven/components/trunk/maven-site/src/site/apt/where-is-it.apt (original) +++ maven/components/trunk/maven-site/src/site/apt/where-is-it.apt Mon Oct 31 21:23:16 2005 @@ -1,12 +1,12 @@ ------ - Where the [EMAIL PROTECTED] is it! + Where is it? ------ Jason van Zyl ------ 12 October 2005 ------ -Where the [EMAIL PROTECTED] is it! +Where is it? As we have moved toward the release of Maven 2.0 we have built up a vast store of knowledge that is sometimes hard to communicate with users because Modified: maven/components/trunk/maven-site/src/site/site.xml URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/site.xml?rev=329977&r1=329976&r2=329977&view=diff ============================================================================== --- maven/components/trunk/maven-site/src/site/site.xml (original) +++ maven/components/trunk/maven-site/src/site/site.xml Mon Oct 31 21:23:16 2005 @@ -27,7 +27,8 @@ <item name="Documentation" href="/guides/index.html"/> <item name="Available Plug-ins" href="/plugins/index.html"/> <item name="Plug-in Matrix" href="http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Matrix"/> - <item name="Where the [EMAIL PROTECTED] is it!" href="/where-is-it.html"/> + <item name="Where is it?" href="/where-is-it.html"/> + <item name="How to Help" href="/helping.html"/> </menu> <menu name="About Maven 2.0">