diff --git a/maven-site/src/site/apt/guides/getting-started/ideas.txt b/maven-site/src/site/apt/guides/getting-started/ideas.txt index c290db1927..3f4399ff57 100644 --- a/maven-site/src/site/apt/guides/getting-started/ideas.txt +++ b/maven-site/src/site/apt/guides/getting-started/ideas.txt @@ -6,41 +6,6 @@ 12 October 2005 ----- -Guides - -* Guide to using multiple repositories - - There are two different ways that you can specify the use of multiple repositories. The first - is to specify - -+----+ - - -... - - - my-repo1 - your custom repo - http://jarsm2.dyndns.dk - - - my-repo2 - your custom repo - http://jarsm2.dyndns.dk - - -... - - -+----+ - - - -if you specify repositories in profiles you must remember to activate that -particular profile! and the use of mirrors - -* - * Guide to using project properties Actually, no. It's *like* the properties defined in profiles in syntax, @@ -58,19 +23,6 @@ the element. So: +----+ -* Guide to project inheritance - -Profile inheritance the same as standard inheritence and resources sets are currently not -inherited. - -DefaultModelInheritenceAssembler. - -Merged: -- dependencies -- developers and contributors -- plugin lists (including reports) -- plugin executions with matching ids -- plugin configuration * Guide to system properties @@ -115,59 +67,13 @@ support ntmlv2: http://www.mail-archive.com/httpclient-dev@jakarta.apache.org/msg01861.html -== - -Using extensions and why they are needed. - -== - How to use Ant constructs from m2. -== - -* How maven's classloaders work - - To add a bit of detail for a volunteer to submit as documentation... :) - - m2/core/boot is what is in the java classpath (ie, just classworlds, - which constructs classloaders for the rest of the system) - - the top level classloader contains plexus container and plexus utils - (see m2/core), and also has access to classworlds - - the next classloader has the libraries in m2/lib (a bug in beta 1 - incorporated commons-logging and -lang, sorry about that!) In general - these are just maven libraries. We hope to further separate these in - future to just be maven apis. - - after that, each plugin has its own classloader, including its - dependencies, itself, and the libraries above. It *does not* contain - the project dependencies like in m1, but instead has access to a list - of JAR files in case they are needed. - - In addition, a project can list "extensions". These are loaded into - the same place as m2/lib and so available to the maven core and all - plugins for the currnet project and subsequent projects (in future, we - plan to remove it from subsequent projects). - - -== - How artifact resolution works, this would be a long one more advanced in scope. == - -== - -When creating your own lifecycles: - -This is a missing instruction on the build lifecycle page. You need to -add the plugin to the project, true - -== - How snapshots works == @@ -228,10 +134,6 @@ How to modify the manifest. ~~ * How do I deal with a dependency that is already supplied by my runtime? -~~* How do I deploy my jar in Ibiblio? - -~~* How do I internationalize my site? - +-----+ ~~ How to do a test release and deployment. Trying to work through this with raphael at the moment. diff --git a/maven-site/src/site/apt/guides/getting-started/introduction-to-the-pom.apt b/maven-site/src/site/apt/guides/getting-started/introduction-to-the-pom.apt index 27d9ff7b45..efa34715bc 100644 --- a/maven-site/src/site/apt/guides/getting-started/introduction-to-the-pom.apt +++ b/maven-site/src/site/apt/guides/getting-started/introduction-to-the-pom.apt @@ -14,6 +14,8 @@ Introduction to the POM o Explain the notion of the Super POM o Show what a minimal POM can look like +* {{Super POM}} + %{snippet|id=superpom|url=http://svn.apache.org/repos/asf/maven/components/trunk/maven-project/src/main/resources/org/apache/maven/project/pom-4.0.0.xml} +-----+ @@ -35,3 +37,20 @@ Introduction to the POM +-----+ + +* Project Inheritance + + Elements in the POM that are merged are the following: + + * dependencies + + * developers and contributors + + * plugin lists (including reports) + + * plugin executions with matching ids + + * plugin configuration + + <> Profile inheritance the same inheritance strategy as used for the POM itself. + diff --git a/maven-site/src/site/apt/plugin-overview.apt b/maven-site/src/site/apt/guides/getting-started/plugin-overview.apt similarity index 100% rename from maven-site/src/site/apt/plugin-overview.apt rename to maven-site/src/site/apt/guides/getting-started/plugin-overview.apt diff --git a/maven-site/src/site/apt/plugin-prefix-mapping-overview.apt b/maven-site/src/site/apt/guides/getting-started/plugin-prefix-mapping-overview.apt similarity index 100% rename from maven-site/src/site/apt/plugin-prefix-mapping-overview.apt rename to maven-site/src/site/apt/guides/getting-started/plugin-prefix-mapping-overview.apt diff --git a/maven-site/src/site/apt/plugin-registry-overview.apt b/maven-site/src/site/apt/guides/getting-started/plugin-registry-overview.apt similarity index 100% rename from maven-site/src/site/apt/plugin-registry-overview.apt rename to maven-site/src/site/apt/guides/getting-started/plugin-registry-overview.apt diff --git a/maven-site/src/site/apt/profiles-overview.apt b/maven-site/src/site/apt/guides/getting-started/profiles-overview.apt similarity index 100% rename from maven-site/src/site/apt/profiles-overview.apt rename to maven-site/src/site/apt/guides/getting-started/profiles-overview.apt diff --git a/maven-site/src/site/apt/repositories-and-artifact-resolution-overview.apt b/maven-site/src/site/apt/guides/getting-started/repositories-and-artifact-resolution-overview.apt similarity index 100% rename from maven-site/src/site/apt/repositories-and-artifact-resolution-overview.apt rename to maven-site/src/site/apt/guides/getting-started/repositories-and-artifact-resolution-overview.apt diff --git a/maven-site/src/site/apt/guides/mini/guide-deployment-security-settings.apt b/maven-site/src/site/apt/guides/mini/guide-deployment-security-settings.apt index d8f23f940f..b1bc4038d6 100644 --- a/maven-site/src/site/apt/guides/mini/guide-deployment-security-settings.apt +++ b/maven-site/src/site/apt/guides/mini/guide-deployment-security-settings.apt @@ -1,5 +1,5 @@ ------ - Configuring Deployment Security Settings + Guide to Deployment and Security Settings ------ Jason van Zyl ------ diff --git a/maven-site/src/site/apt/guides/mini/guide-generating-sources.apt b/maven-site/src/site/apt/guides/mini/guide-generating-sources.apt new file mode 100644 index 0000000000..52da157683 --- /dev/null +++ b/maven-site/src/site/apt/guides/mini/guide-generating-sources.apt @@ -0,0 +1,7 @@ + ------ + Guide + ------ + Jason van Zyl + ------ + 12 October 2005 + ------ diff --git a/maven-site/src/site/apt/guides/mini/guide-maven-classloading.apt b/maven-site/src/site/apt/guides/mini/guide-maven-classloading.apt new file mode 100644 index 0000000000..3987be98a0 --- /dev/null +++ b/maven-site/src/site/apt/guides/mini/guide-maven-classloading.apt @@ -0,0 +1,32 @@ + ------ + Guide to Maven Classloading + ------ + Jason van Zyl + ------ + 12 October 2005 + ------ + +How maven's classloaders work + + To add a bit of detail for a volunteer to submit as documentation... :) + + m2/core/boot is what is in the java classpath (ie, just classworlds, + which constructs classloaders for the rest of the system) + + the top level classloader contains plexus container and plexus utils + (see m2/core), and also has access to classworlds + + the next classloader has the libraries in m2/lib (a bug in beta 1 + incorporated commons-logging and -lang, sorry about that!) In general + these are just maven libraries. We hope to further separate these in + future to just be maven apis. + + after that, each plugin has its own classloader, including its + dependencies, itself, and the libraries above. It *does not* contain + the project dependencies like in m1, but instead has access to a list + of JAR files in case they are needed. + + In addition, a project can list "extensions". These are loaded into + the same place as m2/lib and so available to the maven core and all + plugins for the currnet project and subsequent projects (in future, we + plan to remove it from subsequent projects). diff --git a/maven-site/src/site/apt/guides/mini/guide-mirror-settings.apt b/maven-site/src/site/apt/guides/mini/guide-mirror-settings.apt index f4128563ec..a110a00570 100644 --- a/maven-site/src/site/apt/guides/mini/guide-mirror-settings.apt +++ b/maven-site/src/site/apt/guides/mini/guide-mirror-settings.apt @@ -1,5 +1,5 @@ ------ - Configuring Mirror Settings + Guide to Mirror Settings ------ Jason van Zyl ------ diff --git a/maven-site/src/site/apt/guides/mini/guide-multiple-repositories.apt b/maven-site/src/site/apt/guides/mini/guide-multiple-repositories.apt new file mode 100644 index 0000000000..016a31ebe3 --- /dev/null +++ b/maven-site/src/site/apt/guides/mini/guide-multiple-repositories.apt @@ -0,0 +1,86 @@ + ------ + Guide to using Multiple Repositories + ------ + Jason van Zyl + ------ + 12 October 2005 + ------ + +Setting up Multiple Repositories + + There are two different ways that you can specify the use of multiple repositories. The first + way is to specify in a POM which repositories you want to use: + ++----+ + + +... + + + my-repo1 + your custom repo + http://jarsm2.dyndns.dk + + + my-repo2 + your custom repo + http://jarsm2.dyndns.dk + + +... + + ++----+ + + The <<>> element is inherited so you would usually specify the repositories + to use for a group of projects by defining a <<>> element at the top of your + inheritance chain. + + <> You will also get the standard set of repositories as defined in the + {{{../getting-started/introduction-to-the-pom.html#Super POM}Super POM}}. + + The other way you can specify the use of multiple repositories by creating a profile in + your <<<~/.m2/settings.xml>>> file like the following: + ++----+ + + + ... + + ... + + myprofile + + + my-repo2 + your custom repo + http://jarsm2.dyndns.dk + + + + ... + + + + myprofile + + ... + + ++----+ + + If you specify repositories in profiles you must remember to activate that + particular profile! As you can see above we do this by registering a profile + to be active in the <<>> element. + + You could also activate this profile on the command like by executing the following + command: + ++----+ + +m2 -Pmyprofile ... + ++----+ + + In fact the <<<-P>>> option will take a CSV list of profiles to activate if you wish to + activate multiple profiles simultaneously. \ No newline at end of file diff --git a/maven-site/src/site/apt/guides/mini/configuring-proxy-settings.apt b/maven-site/src/site/apt/guides/mini/guide-proxy-settings.apt similarity index 97% rename from maven-site/src/site/apt/guides/mini/configuring-proxy-settings.apt rename to maven-site/src/site/apt/guides/mini/guide-proxy-settings.apt index 947fc27653..7118495890 100644 --- a/maven-site/src/site/apt/guides/mini/configuring-proxy-settings.apt +++ b/maven-site/src/site/apt/guides/mini/guide-proxy-settings.apt @@ -1,5 +1,5 @@ ------ - Configuring Proxy Settings + Guide to Proxy Settings ------ Jason van Zyl ------ diff --git a/maven-site/src/site/apt/guides/mini/guide-template.apt b/maven-site/src/site/apt/guides/mini/guide-template.apt new file mode 100644 index 0000000000..52da157683 --- /dev/null +++ b/maven-site/src/site/apt/guides/mini/guide-template.apt @@ -0,0 +1,7 @@ + ------ + Guide + ------ + Jason van Zyl + ------ + 12 October 2005 + ------ diff --git a/maven-site/src/site/apt/guides/mini/guide-using-extensions.apt b/maven-site/src/site/apt/guides/mini/guide-using-extensions.apt new file mode 100644 index 0000000000..47b2b23b46 --- /dev/null +++ b/maven-site/src/site/apt/guides/mini/guide-using-extensions.apt @@ -0,0 +1,17 @@ + ------ + Guide to using Extensions + ------ + Jason van Zyl + ------ + 12 October 2005 + ------ + +Using Extensions + + * Maven Wagon Providers + * Maven SCM Providers + * Plug-ins that define their own lifecycle + + When creating your own lifecycles: + This is a missing instruction on the build lifecycle page. You need to + add the plugin to the project, true diff --git a/maven-site/src/site/apt/guides/mini/index.apt b/maven-site/src/site/apt/guides/mini/index.apt new file mode 100644 index 0000000000..99027825b5 --- /dev/null +++ b/maven-site/src/site/apt/guides/mini/index.apt @@ -0,0 +1,9 @@ + ------ + Maven Mini Guides + ------ + Jason van Zyl + ------ + 12 October 2005 + ------ + +Maven Mini Guides