From 5421754a17743f313c90f0cda430cc67529b2f29 Mon Sep 17 00:00:00 2001 From: Jason van Zyl Date: Fri, 14 Oct 2005 01:09:16 +0000 Subject: [PATCH] more updates to docs git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@320958 13f79535-47bb-0310-9956-ffa450edef68 --- maven-site/my-app/pom.xml | 1 + maven-site/src/site/apt/guides/header.apt | 9 +- .../introduction-to-archetypes.apt | 22 ++++- .../introduction-to-dependency-management.apt | 99 +++++++++++++++---- .../src/site/apt/guides/mini/guide-m1-m2.apt | 5 +- .../site/apt/guides/mini/guide-releasing.apt | 2 + .../{site.apt => guides/mini/guide-site.apt} | 4 +- maven-site/src/site/apt/guides/toc.apt | 15 ++- maven-site/src/site/site.xml | 3 + 9 files changed, 129 insertions(+), 31 deletions(-) rename maven-site/src/site/apt/{site.apt => guides/mini/guide-site.apt} (99%) diff --git a/maven-site/my-app/pom.xml b/maven-site/my-app/pom.xml index b693b69437..2a433c26e5 100644 --- a/maven-site/my-app/pom.xml +++ b/maven-site/my-app/pom.xml @@ -22,6 +22,7 @@ src/main/filters/filters.properties + ${pom.build.directory} src/main/resources diff --git a/maven-site/src/site/apt/guides/header.apt b/maven-site/src/site/apt/guides/header.apt index 7b1a5e78f3..59d16eafee 100644 --- a/maven-site/src/site/apt/guides/header.apt +++ b/maven-site/src/site/apt/guides/header.apt @@ -8,14 +8,17 @@ Documentation - -* Guides +* Getting Started Guide * {{{getting-started/index.html}Getting Started Guide}} - * {{{plugin/guide-plugin-development.html}Plug-in Developer's Guide}} +* Developer Guides * {{{development/guide-m2-development.html}Guide to Developing Maven 2.x}} * {{{development/guide-building-m2.html}Guide to Building Maven 2.x}} +* Plug-in Guides + + * {{{plugin/guide-plugin-development.html}Plug-in Developer's Guide}} + diff --git a/maven-site/src/site/apt/guides/introduction/introduction-to-archetypes.apt b/maven-site/src/site/apt/guides/introduction/introduction-to-archetypes.apt index 14e317f7f5..4682f75fd8 100644 --- a/maven-site/src/site/apt/guides/introduction/introduction-to-archetypes.apt +++ b/maven-site/src/site/apt/guides/introduction/introduction-to-archetypes.apt @@ -15,6 +15,26 @@ What is Archetype? provides a consistent means of generating Maven projects. Archetype will help authors create Maven project templates for users, and provides users with the means to generate parameterized versions of those project templates. + + Using archetypes provides a great way to enable developers quickly in a way consistent with best practices employed + by your project or organization. Within the Maven project we use archetypes to try and get our users up and running + as quickly as possible by providing a sample project that demonstrates many of the features of Maven while introducing + new users to the best practices employed by Maven. In a matter of seconds a new user can have a working Maven project + to use a jumping board for investigating more of the features in Maven. We have also tried to make the Archetype + mechanism additive and by that we mean allowing portions of a project to captured in an archetype so that pieces + or aspects of a project can be added to existing projects. A good example of this is the Maven site archetype. + If, for example, you have used the quick start archetype to generate a working project you can then quickly + create a site for that project by using the site archetype within that existing project. You can do anything like + this with archetypes. + + You may want to standardize J2EE development within your organization so you may want to provide archetypes + for EJBs, or WARs, or for your web services. Once these archetypes are created and deployed in your organizations + repository they are available for use by all developers within your organization. + +* What makes up an Archetype? - + Archetypes are packaged up in a JAR and they consist of the archetype metadata which describes the contents of + archetype and a set of {{{http://jakarta.apache.org/velocity}Velocity}} templates which make up the prototype + project. If you would like to know how to make your archetypes please refer to our + {{{../mini/guide-creating-archetypes.html}Guide to creating archetypes}}. diff --git a/maven-site/src/site/apt/guides/introduction/introduction-to-dependency-management.apt b/maven-site/src/site/apt/guides/introduction/introduction-to-dependency-management.apt index 580c2b8e73..072c3df1c2 100644 --- a/maven-site/src/site/apt/guides/introduction/introduction-to-dependency-management.apt +++ b/maven-site/src/site/apt/guides/introduction/introduction-to-dependency-management.apt @@ -1,36 +1,97 @@ ------ - Introduction to Dependency Management + Introduction to dependency management ------ Jason van Zyl ------ 12 October 2005 ------ -Introduction to Dependency Management +Introduction to dependency management -* How to Maintain Versions of Dependencies + Dependency management is one of the features of Maven that is best know to users and is one of the areas where + Maven excels. There is not much difficulty in managing dependencies for a single a project, but when you start + getting into dealing with multi-module projects and applications that consist of tens or hundreds of modules this + is where Maven can help you a great deal in maintaining a high degree of control and stability. - In a multi-project +* How to maintain versions of dependencies in a multi-module - so using something as geronimo/continuum/cargo as an example i can document that placing all deps used by the overall project in a TLP depMan section is the way to go? ++----+ - o use TLP for all deps used in a project - o in each project declare the dep and using groupId/artifactId and scope + + 4.0.0 + com.mycompany.app + app + jar + 1.0-SNAPSHOT + Application + http://app.mycompany.com - if you provide exclusions in your dependency, and exclusions in your depMgmt, the exclusions are NOT merged...local always wins - it's only an issue for exclusions, because it's a complex element + + + + junit + junit + 3.8.1 + + test + + + + - so exclusions in the depMan element at the parent level and child level are not merged? is that correct? - and the child level will win for a given dependency? - um, not sure how that works...haven't looked at it, but I believe that's correct... - I'd have to look at the code ++----+ - and injection only happens if there isn't something in the way - :) ++----+ -injection in depMan + + + com.mycompany.app + app + + 1.0-SNAPSHOT + + 4.0.0 + app-module-foo + jar + + 1.0-SNAPSHOT + Application Foo Module ------ + + + junit + junit + + + ------ - ++----+ + ++----+ + + + + com.mycompany.app + app + + 1.0-SNAPSHOT + + 4.0.0 + app-module-foo + jar + + 1.0-SNAPSHOT + Application Foo Module + + + + junit + junit + + + + ++----+ + +~~ Exclusions in depMan and exclusions in child dep are not merged +~~ What other gotchas? diff --git a/maven-site/src/site/apt/guides/mini/guide-m1-m2.apt b/maven-site/src/site/apt/guides/mini/guide-m1-m2.apt index 876ea2b99b..8bbe5ef6c7 100644 --- a/maven-site/src/site/apt/guides/mini/guide-m1-m2.apt +++ b/maven-site/src/site/apt/guides/mini/guide-m1-m2.apt @@ -6,7 +6,8 @@ 12 October 2005 ------ - * repoclean +~~ merge in the m1 FAQ +~~ repoclean ** Projects using multiproject or project properties @@ -21,4 +22,4 @@ http://blogs.codehaus.org/people/vmassol/archives/001170_javazone_2005.html -~~ doco coming from jay hartley \ No newline at end of file +~~ doco coming from jay hartley diff --git a/maven-site/src/site/apt/guides/mini/guide-releasing.apt b/maven-site/src/site/apt/guides/mini/guide-releasing.apt index 110d8c0a51..0cd680b755 100644 --- a/maven-site/src/site/apt/guides/mini/guide-releasing.apt +++ b/maven-site/src/site/apt/guides/mini/guide-releasing.apt @@ -6,6 +6,8 @@ 12 October 2005 ----- +~~ integrate releasing document + Releasing The release plugin provides some basic functionality for making releases, and updating diff --git a/maven-site/src/site/apt/site.apt b/maven-site/src/site/apt/guides/mini/guide-site.apt similarity index 99% rename from maven-site/src/site/apt/site.apt rename to maven-site/src/site/apt/guides/mini/guide-site.apt index bd08e594fe..4cfe20ed0d 100644 --- a/maven-site/src/site/apt/site.apt +++ b/maven-site/src/site/apt/guides/mini/guide-site.apt @@ -1,5 +1,5 @@ ------ - Generating a Site + Guide to creating a site ------ Brett Porter Jason van Zyl @@ -7,7 +7,7 @@ 13 May 2005 ------ -Building a Site +Creating a site * Creating Content diff --git a/maven-site/src/site/apt/guides/toc.apt b/maven-site/src/site/apt/guides/toc.apt index a0166d503b..dbe278dd66 100644 --- a/maven-site/src/site/apt/guides/toc.apt +++ b/maven-site/src/site/apt/guides/toc.apt @@ -8,17 +8,20 @@ Documentation - -* Guides +* Getting Started Guide * {{{getting-started/index.html}Getting Started Guide}} - * {{{plugin/guide-plugin-development.html}Plug-in Developer's Guide}} +* Developer Guides * {{{development/guide-m2-development.html}Guide to Developing Maven 2.x}} * {{{development/guide-building-m2.html}Guide to Building Maven 2.x}} +* Plug-in Guides + + * {{{plugin/guide-plugin-development.html}Plug-in Developer's Guide}} + * Mini Guides * {{{mini/guide-apt-format.html}Guide to the APT Format}} @@ -63,6 +66,10 @@ Documentation * {{{mini/guide-proxies.html}Guide to using proxies}} + * {{{mini/guide-releasing.html}Guide to Releasing}} + + * {{{mini/guide-site.html}Guide to creating a site}} + * {{{mini/guide-test-customization.html}Guide to test customization}} * {{{mini/guide-using-extensions.html}Guide to using Extensions}} @@ -74,7 +81,7 @@ Documentation * {{{introduction/introduction-to-archetypes.html}Introduction to Archetypes}} - * {{{introduction/introduction-to-dependency-management.html}Introduction to Dependency Management}} + * {{{introduction/introduction-to-dependency-management.html}Introduction to dependency management}} * {{{introduction/introduction-to-repositories.html}Introduction to Repositories}} diff --git a/maven-site/src/site/site.xml b/maven-site/src/site/site.xml index 5c4cc144b1..caa8a16374 100644 --- a/maven-site/src/site/site.xml +++ b/maven-site/src/site/site.xml @@ -42,6 +42,7 @@ --> + +