svn commit: r330123 - in /maven/components/trunk/maven-site/src/site/apt/guides: index.apt mini/guide-ibiblio-upload.apt mini/guide-maven-evangelism.apt mini/guide-naming-conventions.apt

[ca...@apache.org]

Author: carlos
Date: Tue Nov  1 13:02:38 2005
New Revision: 330123

URL: http://svn.apache.org/viewcvs?rev=330123&view=rev
Log:
Added guide-naming-conventions

Added:
    maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt   (with props)
Modified:
    maven/components/trunk/maven-site/src/site/apt/guides/index.apt
    maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt
    maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-maven-evangelism.apt   (props changed)

Modified: maven/components/trunk/maven-site/src/site/apt/guides/index.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/index.apt?rev=330123&r1=330122&r2=330123&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/index.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/guides/index.apt Tue Nov  1 13:02:38 2005
@@ -40,6 +40,8 @@
 
  * {{{mini/guide-generating-sources.html}Guide to generating Sources}}
 
+ * {{{mini/guide-naming-conventions.html}Guide to naming conventions (groupId, artifactId, version)}}
+
  * {{{mini/guide-ibiblio-upload.html}Guide to uploading artifacts to Ibiblio}}
 
  * {{{mini/guide-maven-evangelism.html}Guide to maven evangelism, improving metadata in ibiblio}}

Modified: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt?rev=330123&r1=330122&r2=330123&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt Tue Nov  1 13:02:38 2005
@@ -97,7 +97,8 @@
  be equal to the previous used, but for new projects it has to follow the package name rules, what
  means that has to be at least as a domain name you control, and you can create as many subgroups
  as you want. Look at {{{http://java.sun.com/docs/books/jls/third_edition/html/packages.html#7.7}
- More information about package names}}}.
+ More information about package names}}. Check also the guide about
+ {{{guide-naming-conventions.html}Maven naming conventions}}
 
  Examples:
 

Propchange: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-maven-evangelism.apt
------------------------------------------------------------------------------
    eol-style = native

Propchange: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-maven-evangelism.apt
------------------------------------------------------------------------------
    keywords = Author Date Id Revision

Added: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt?rev=330123&view=auto
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt (added)
+++ maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt Tue Nov  1 13:02:38 2005
@@ -0,0 +1,32 @@
+ ------
+ Guide to Naming Conventions
+ ------
+ Carlos Sanchez
+ ------
+ 1 November 2005
+ ------
+
+Guide to naming conventions on groupId, artifactId and version
+
+ []
+
+ * <<groupId>> it will identify your project uniquely in internet
+ so we need to enforce a naming schema. It has to follow the package name rules, what
+ means that has to be at least as a domain name you control, and you can create as many subgroups
+ as you want. Look at {{{http://java.sun.com/docs/books/jls/third_edition/html/packages.html#7.7}
+ More information about package names}}.
+
+ eg. <<<org.apache.maven>>>, <<<org.apache.jakarta.commons>>>
+
+ * <<artifactId>> the name of the jar without version. If you created it then you can choose
+ whatever name you want with lowercase letters and no strange symbols. If it's a third party jar
+ you have to take the name of the jar as it's distributed.
+
+ eg. <<<maven>>>, <<<commons-math>>>
+
+ * <<version>> if you distribute it then you can choose any typical version with numbers and dots
+ (1.0, 1.1, 1.0.1, ...).
+ Don't use dates as they are usually associated with snapshot (nightly) builds. If it's a third
+ party artifact, you have to use their version number whatever it is, and as strange it can look.
+
+ eg. <<<2.0>>>, <<<2.0.1>>>, <<<1.3.1>>>

Propchange: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt
------------------------------------------------------------------------------
    eol-style = native

Propchange: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt
------------------------------------------------------------------------------
    keywords = Author Date Id Revision

Propchange: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-naming-conventions.apt
------------------------------------------------------------------------------
    svn:eol-style = native