diff --git a/maven-site/src/site/apt/release-notes.apt b/maven-site/src/site/apt/release-notes.apt new file mode 100644 index 0000000000..f7a2ce9a24 --- /dev/null +++ b/maven-site/src/site/apt/release-notes.apt @@ -0,0 +1,48 @@ + ------ +Release Notes - Maven 2.0 Alpha 2 + ------ +Brett Porter + ------ +13 May 2005 + ------ + + The Apache Maven team are proud to announce the second alpha release of Maven 2.0. + + Download it from {{http://maven.apache.org/maven2/download.html}} + + Maven is a software project management and comprehension tool. Based on the concept of a project object model + (POM), Maven can manage a project's build, reporting and documentation from a central piece of information. + + This release includes <<{{{http://jira.codehaus.org/secure/IssueNavigator.jspa?reset=true&pid=10500&fixfor=11020} 76 bug fixes and enhancements}}>> since the + first release on 8 April. + + Maven 2.0 is a rewrite of the popular Maven application to achieve a number of goals, and to provide a stable + basis to take it into the future. While it can be considered quite stable, and future versions are now expected to + retain a high amount of backwards compatibility, this is still a technology preview, and not yet complete or + considered ready for a production environment. + + The main new features in this release are: + + * Basic site generation + + * Improved error handling + + * Automatic plugin updates + + * Published Mojo and Plugin API + + * Inclusion of Ant tasks for Maven 2.0 + + This release is expected to be much more architecturally stable, making early adoption + a possiblity. At this point, there are still only the core plugins available. + + We hope you enjoy using Maven! If you have any questions, please consult: + + * the web site: {{http://maven.apache.org/maven2/}} + + * the maven-user mailing list: {{http://maven.apache.org/mail-lists.html}} + + For news and information, see: + + * Maven Blogs: {{http://www.mavenblogs.com/}} + diff --git a/maven-site/src/site/apt/site.apt b/maven-site/src/site/apt/site.apt new file mode 100644 index 0000000000..87b66af7e0 --- /dev/null +++ b/maven-site/src/site/apt/site.apt @@ -0,0 +1,141 @@ + ------ + Generating a Site + ------ + Brett Porter + ------ + 13 May 2005 + ------ + +Building a Site + +* Creating Content + + The first step to creating your site is to create some content. In Maven 2.0, the site content is separated by format, + as there are several available. + +------------------- ++- src/ + +- site/ + +- apt/ + | +- index.apt + | + +- xdoc/ + | +- other.xml + | + +- fml/ + | +- general.fml + | +- faq.fml + | + +- site.xml +-------------------- + + The Xdoc format is the same as {{{http://maven.apache.org/using/site.html} used in Maven 1.0}}. However, <<>> + has been replaced by the site descriptor (see below). + + The APT format, "Almost Plain Text", is a wiki-like format that allows you to write simple, structured documents (like this) + very quickly. A full reference of the {{{http://www.xmlmind.com/_aptconvert/docs/userguide2.html#id.s2} APT Format}} is available. + + The FML format is the FAQ format, also used in Maven 1.0. + + Other formats are available, but at this point these 3 are the best tested. There are also several possible output formats, + but as of alpha-2, only XHTML is available. + + Note that all of the above is optional - just one index file is required in one of the input trees. Each of the paths will be merged + together to form the root directory of the site. + +* Generating The Site + + Generating the site is very simple, and fast! + +--------------- +m2 site:site +--------------- + + The resulting site will be in <<>> + + For more information on the site plugin, see the {{{plugins/maven-site-plugin/} plugin reference}}. + +* Deploying The Site + + To be able to deploy the site, you must first declare a location to distribute to in your <<>>, similar to the repository for + deployment. + +--------------- + + + website + scp://www.mycompany.com/www/docs/project/ + + +--------------- + + The <<>> element identifies the repository, so that you can attach credentials to it in your <<>> + file in the same way as you would for any other repository. The URL gives the location to deploy to. Currently, + only SSH is supported, as above which copies to the host <<>> in the path <<>>. + + Deploying the site is done with the <<>> goal. Note that you cannot just call the deployment goal on its own, however. + You must presently run the <<>> goal independantly. + +--------------- +m2 site:site site:deploy +--------------- + + <> the trailing slash in the URL above indicates that any subprojects that inherit this value should append their artifact ID to + the path instead of using it as is. + +* Creating a Site Descriptor + + The <<>> file is used to describe the layout of the site, and replaces the navigation file used in Maven 1.0. + + A sample is given below: + +-------------------- + + + + Maven + http://maven.apache.org/images/apache-maven-project.png + http://maven.apache.org/ + + + http://maven.apache.org/images/maven-small.gif + + + + + + + + + + + + + + + + + ... + + +-------------------- + + ~~TODO: deserves more explanation. + +* Adding Additional Resources + + You can also add images and CSS to your site, by creating the following directories in your site sources: + +------------------- ++- src/ + +- site/ + +- css/ + | +- site.css + | + +- images/ + | +- pic1.jpg + | +-------------------- + + The file <<>> will be added to the default XHTML output, so can be used to adjust the default Maven stylesheets if desired. + diff --git a/maven-site/src/site/site.xml b/maven-site/src/site/site.xml index 902183985c..685c3876fc 100644 --- a/maven-site/src/site/site.xml +++ b/maven-site/src/site/site.xml @@ -18,6 +18,7 @@ + @@ -28,12 +29,13 @@ + - - - - + + + + diff --git a/maven-site/src/site/xdoc/configuration.xml b/maven-site/src/site/xdoc/configuration.xml index 0c2b379fdb..9f7e22a75a 100644 --- a/maven-site/src/site/xdoc/configuration.xml +++ b/maven-site/src/site/xdoc/configuration.xml @@ -35,13 +35,11 @@

You can specify your user configuration in ${user.home}/.m2/settings.xml. A - full reference to the + full reference to 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.

-

- Configuring your Local Repository -

+

Configuring your Local Repository

The local repository is part of a profile in your user configuration. You can have multiple profiles, with one set to active so that you can switch environments. @@ -61,9 +59,7 @@

The local repository must be an absolute path.

-

- Configuring a Proxy -

+

Configuring a Proxy

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 diff --git a/maven-site/src/site/xdoc/developers/mojo-api-specification.xml b/maven-site/src/site/xdoc/developers/mojo-api-specification.xml index 7a9c336567..692647634e 100644 --- a/maven-site/src/site/xdoc/developers/mojo-api-specification.xml +++ b/maven-site/src/site/xdoc/developers/mojo-api-specification.xml @@ -458,7 +458,7 @@ rather than plugin configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you want the user to modify - <build><finalName/></build> rather than + <build><finalName/></build> rather than specifying a value for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a List-typed parameter which expects items of type diff --git a/maven-site/src/site/xdoc/docs-required.xml b/maven-site/src/site/xdoc/docs-required.xml index 58438a2c56..85d52093ff 100644 --- a/maven-site/src/site/xdoc/docs-required.xml +++ b/maven-site/src/site/xdoc/docs-required.xml @@ -11,7 +11,7 @@ to let us know at the Maven Users Mailing List.

-

Documentation for users

+

Documentation for users

  • new SNAPSHOT handling - partially done on Brett's blog @@ -19,15 +19,19 @@
  • deployment mechanism
  • build lifecycle documentation
  • dependency management
    • -
  • plugin management
    • +
  • plugin management - in progress by J Matthew Pryor and John Casey
  • plugin configuration
    • -
  • plugin downloading
    • +
  • plugin downloading - partial on Brett's blogs
    • +
  • site generation
    • +
  • report generation
-

Documentation for plugin authors

+

Documentation for plugin authors

  • plugin writing guide
    • +
  • report writing guide
    • +
  • site customisation guide
-

Documentation for Maven developers

+

Documentation for Maven developers

  • Lifecycle architecture
  • High level architecture, components explanation
    • diff --git a/maven-site/src/site/xdoc/getting-started.xml b/maven-site/src/site/xdoc/getting-started.xml index 7120b36172..c575540344 100644 --- a/maven-site/src/site/xdoc/getting-started.xml +++ b/maven-site/src/site/xdoc/getting-started.xml @@ -51,7 +51,7 @@ ]]>

    You can get a full reference to the - project descriptor to see what other + project descriptor to see what other elements are available.

    diff --git a/maven-site/src/site/xdoc/navigation.xml b/maven-site/src/site/xdoc/navigation.xml deleted file mode 100644 index 4c90d4e9ae..0000000000 --- a/maven-site/src/site/xdoc/navigation.xml +++ /dev/null @@ -1,33 +0,0 @@ - - Maven 2 - - - - - - - -

    - - - - - - - - - - - - - - - - - - - - - - - diff --git a/maven-site/src/site/xdoc/plugin-list.xml b/maven-site/src/site/xdoc/plugins/index.html similarity index 95% rename from maven-site/src/site/xdoc/plugin-list.xml rename to maven-site/src/site/xdoc/plugins/index.html index bc179b74e4..f90495bac6 100644 --- a/maven-site/src/site/xdoc/plugin-list.xml +++ b/maven-site/src/site/xdoc/plugins/index.html @@ -25,6 +25,14 @@ Generate an Ant build file for the project + + + archetype + + + Generate a skeleton project structure from an archetype. + + assembly diff --git a/maven-site/src/site/xdoc/roadmap.xml b/maven-site/src/site/xdoc/roadmap.xml index 1a558640fc..f62fc333b7 100644 --- a/maven-site/src/site/xdoc/roadmap.xml +++ b/maven-site/src/site/xdoc/roadmap.xml @@ -22,24 +22,6 @@ We will continue with the successful technique from Maven 1.0 of making plugins available on a separate release schedule so that new features can be obtained as they are ready and tested.

    - -

    - Expected Release: 13 May 2005 -

    -

    - Aims and features: This release is expected to be much more architecturally stable, making early adoption - a real possiblity. At this point, there are still only the core plugins available. -

    -
      -
    • Basic site generation
      • -
    • Improved error handling
      • -
    • Published Mojo and Plugin API
      • -
    • Inclusion of Ant tasks for Maven 2.0
      • -
    • Preliminary Beanshell Mojo support
      • -
    • Miscellaneous feature updates
      • -
    • Bugfixes
      • -
    -

    Expected Release: mid-June 2005 @@ -59,6 +41,7 @@

  • Release assistance
  • Miscellaneous feature updates
  • Bugfixes
    • +
  • Preliminary Beanshell Mojo support