diff --git a/maven-core/src/site/apt/bootstrapping.apt b/maven-core/src/site/apt/bootstrapping.apt deleted file mode 100644 index 8e8a4353ad..0000000000 --- a/maven-core/src/site/apt/bootstrapping.apt +++ /dev/null @@ -1,15 +0,0 @@ - ----- - Bootstrapping - ----- - The Maven Team - ----- - -Installing maven2 - - * Download m2 {{{http://www.apache.org/~jvanzyl/m2/m2.tgz}here}}. - - * Unpack in your home directory. In will expand in a directory called <<>>. - - * Put ~/m2/bin in your path. - - * Run m2! i.e. <<>>. diff --git a/maven-core/src/site/apt/faq.apt b/maven-core/src/site/apt/faq.apt deleted file mode 100644 index f1fedbbc8d..0000000000 --- a/maven-core/src/site/apt/faq.apt +++ /dev/null @@ -1,9 +0,0 @@ - ----- - FAQ - ----- - The Maven Team - ----- - -Maven2 - - This is maven2. Dig it. diff --git a/maven-core/src/site/apt/index.apt b/maven-core/src/site/apt/index.apt deleted file mode 100644 index 940451d313..0000000000 --- a/maven-core/src/site/apt/index.apt +++ /dev/null @@ -1,9 +0,0 @@ - ----- - Maven2 - ----- - The Maven Team - ----- - -Maven2 - - This is maven2. Dig it. diff --git a/maven-core/src/site/apt/install.apt b/maven-core/src/site/apt/install.apt deleted file mode 100644 index f54146e36d..0000000000 --- a/maven-core/src/site/apt/install.apt +++ /dev/null @@ -1,26 +0,0 @@ - ----- - Installing maven2 - ----- - The Maven Team - ----- - -Installing maven2 - - * - - - * Download m2 {{{http://www.apache.org/~jvanzyl/m2/m2.tgz}here}}. - - * Unpack in your home directory. In will expand in a directory called <<>>. - - * Put ~/m2/bin in your path. - - * Run m2! i.e. <<>>. - -* Notes - - * Is M2_HOME required? - - * Format of override needed - - * All the m2 POMs are missing from ibiblio diff --git a/maven-core/src/site/apt/mojos.apt b/maven-core/src/site/apt/mojos.apt deleted file mode 100644 index 9df39f2fed..0000000000 --- a/maven-core/src/site/apt/mojos.apt +++ /dev/null @@ -1,46 +0,0 @@ - ----- - Maven Java objects (Mojos) - ----- - The Maven Team - ---- - -Maven Java objects - - Maven Java objects try to be the simplest form of Java object that can be - - -+-----+ -public class CompilerMojo - extends AbstractMojo -{ - public void execute( MojoRequest request, MojoResponse response ) - { - // Extract parameters from the request - - String sourceDirectory = (String) request.getParameter( "sourceDirectory" ); - - String outputDirectory = (String) request.getParameter( "outputDirectory" ); - - try - { - compiler.compile( sourceDirectory, outputDirectory ); - } - catch( Exception e ) - { - response.setException( e ); - } - } -} -+-----+ - -Parameters available to Mojos - -*----------*-------------------------------------------------------------------* -#project | The MavenProject object: - | You can use #project itself or any valid OGNL expression to - | extract any part of the MavenProject object graph -*----------*-------------------------------------------------------------------* -#component | Any arbitrary Plexus component: - | By using the role name of the plexus component you can use the - | said component in your mojo. Usage: #component. -*----------*-------------------------------------------------------------------* diff --git a/maven-core/src/site/apt/plugins.apt b/maven-core/src/site/apt/plugins.apt deleted file mode 100644 index f4385aad3b..0000000000 --- a/maven-core/src/site/apt/plugins.apt +++ /dev/null @@ -1,15 +0,0 @@ - ----- - Maven plugins - ----- - The Maven Team - ----- - -Maven plugins - - Maven plugins are comprised of any number of {{{mojos.html}mojos}} which are simple classes that - perform a single action and goals that are a parameterized execution of a mojo. - - Goals can also be a different parameterization of the same mojo. - - This definition could certainly be refined and cleaned up with some examples - and diagrams. diff --git a/maven-core/src/site/apt/repository-upload.apt b/maven-core/src/site/apt/repository-upload.apt deleted file mode 100644 index fec199f711..0000000000 --- a/maven-core/src/site/apt/repository-upload.apt +++ /dev/null @@ -1,42 +0,0 @@ - ----- - Ibiblio syncing - ----- - The Maven Team - ----- - -Ibiblio syncing - - The requirements for setting up an automated sync with Ibiblio are as - follows: - - * An account with the user name <<>>. - - * Install this ssh2 DSA public key. You do this by concatenating the - public key to your <<>> file in the <<<.ssh>>> directory - of the user you set up for syncing. - - * Provide the host name and directory on the host where your maven repository - is located. - - Ulimately we want to be able to create a simple rsync script that can be - run from the Ibiblio server. It might look like the following: - -+-----+ - rsync -rvl --size-only --ignore-existing --rsh="ssh -l rsync" beaver.codehaus.org:/dist/ /public/html/maven -+-----+ - - The diretory that we sync from your end must be in the format of a maven - repository. A simple example of the layout expected is as follows: - -+----+ -. -|-- osworkflow -| |-- jars -| |-- licenses -| `-- poms -`-- sitemesh - |-- jars - |-- licenses - `-- poms - -+----+ diff --git a/maven-site/src/site/xdoc/configuration.xml b/maven-site/src/site/xdoc/configuration.xml index a8b5d75163..da133dd506 100644 --- a/maven-site/src/site/xdoc/configuration.xml +++ b/maven-site/src/site/xdoc/configuration.xml @@ -10,14 +10,14 @@

  • - Project - most static configuration occurs in + Project- most static configuration occurs in pom.xml
  • - Installation - this is configuration added once for a Maven installation (not supported in the initial Technology Preview) + Installation- this is configuration added once for a Maven installation
  • - User - this is configuration specific to a particular user + User- this is configuration specific to a particular user

@@ -25,17 +25,18 @@ building it, while the others both define settings for the current environment.

- Note: the installation and user configuration can not be used to add shared project information - + Note:the installation and user configuration can not be used to add shared project information - for example setting - <organization> or - <distributionManagement> company-wide. + <organization>or + <distributionManagement>company-wide. For this, you should have your projects inherit from a company-wide parent pom.xml.

- You can specify your user configuration in ${user.home}/.m2/settings.xml. A - full reference to the + You can specify your user configuration in + ${user.home}/.m2/settings.xml. A + full referenceto the configuration file is available. This section will show how to make some common configurations. Note that the file is not required - defaults will be used if it is not found.

@@ -58,13 +59,15 @@

You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. The username and password are only required if your proxy requires basic authentication (note that later alphas will support - storing your passwords in a secured keystore - in the mean time, please ensure your settings.xml + storing your passwords in a secured keystore - in the mean time, please ensure your + settings.xml file is secured with permissions appropriate for your operating system).

- The nonProxyHosts setting accepts wild cards, and each host not to proxy is separated by the - | character. This matches the - JDK configuration equivalent. + The + nonProxyHostssetting accepts wild cards, and each host not to proxy is separated by the + |character. This matches the + JDK configurationequivalent.

@@ -85,14 +88,17 @@ .]]>

Security and Deployment Settings

- Repositories to deploy to are defined in a project in the <distributionManagement> section. + Repositories to deploy to are defined in a project in the + <distributionManagement>section. However, you cannot put your username, password, or other security settings in that project. For that reason, - you should add a server definition to your own settings with an id that matches that of the + you should add a server definition to your own settings with an + idthat matches that of the deployment repository in the project.

In addition, some repositories may require authorisation to download from, so the corresponding settings can - be specified in a server element in the same way. + be specified in a + serverelement in the same way.

Which settings are required will depend on the type of repository you are deploying to. As of the first release, @@ -133,8 +139,12 @@

To configure a mirror of a given repository, you provide it in your settings file, giving the new repository - it's own id and url, and specify the mirrorOf setting that is the ID of - the repository you are using a mirror of. For example, the ID of the main Maven repository included by default is + it's own + idand + url, and specify the + mirrorOfsetting that is the ID of + the repository you are using a mirror of. For example, the ID of the main Maven repository included by default + is central, so to use an Australian mirror, you would configure the following:

- Please note: this particular is not actually set up for Maven 2 yet, so this should be treated as an + Please note:this particular is not actually set up for Maven 2 yet, so this should be treated as an example only.

diff --git a/maven-site/src/site/xdoc/docs-required.xml b/maven-site/src/site/xdoc/docs-required.xml index fad10938bb..5249792738 100644 --- a/maven-site/src/site/xdoc/docs-required.xml +++ b/maven-site/src/site/xdoc/docs-required.xml @@ -18,15 +18,21 @@
  • deployment mechanism
  • dependency management
    • -
  • plugin management - in progress by J Matthew Pryor and John Casey
    • +
  • plugin management - + in progress by J Matthew Pryor and John Casey +
  • plugin configuration
    • -
  • plugin downloading - partial on Brett's blogs
    • -
  • site generation
    • +
  • plugin downloading - + partial on Brett's blogs +
  • report generation
  • project inheritence and company wide strategy
    • +
  • plugin documentation
    • +
  • archetypes - writing and using

    • Documentation for plugin authors

      +
    • Beanshell examples
    • plugin writing guide
    • report writing guide
    • site customisation guide