You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jv...@apache.org on 2005/10/19 21:04:53 UTC
svn commit: r326651 - in
/maven/components/trunk/maven-site/src/site/apt/guides: index.apt
introduction/introduction-to-the-standard-directory-layout.apt
mini/guide-ibiblio-upload.apt tail.txt
Author: jvanzyl
Date: Wed Oct 19 12:04:48 2005
New Revision: 326651
URL: http://svn.apache.org/viewcvs?rev=326651&view=rev
Log:
fix markup
Added:
maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt (with props)
Modified:
maven/components/trunk/maven-site/src/site/apt/guides/index.apt
maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt
maven/components/trunk/maven-site/src/site/apt/guides/tail.txt
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=326651&r1=326650&r2=326651&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 Wed Oct 19 12:04:48 2005
@@ -70,7 +70,7 @@
* {{{mini/guide-using-extensions.html}Guide to using Extensions}}
- * {{{mini/guide-using-modello.htmlt}Guide to using Modello}}
+ * {{{mini/guide-using-modello.html}Guide to using Modello}}
* {{{mini/guide-webapp.html}Guide to Webapps}}
@@ -123,7 +123,13 @@
* {{{../plugins/index.html}Available Plug-ins}}
* {{{../developers/mojo-api-specification.html}Mojo API}}
+
+ * {{{..//mojo-api-specification.html}Mojo API}}
* {{{../ant-tasks.html}Ant Tasks}}
+
+ * {{{../glossary.html}Glossary}}
+
+ * {{{../maven-conventions.html}Maven Conventions}}
[]
Modified: maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt?rev=326651&r1=326650&r2=326651&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-the-standard-directory-layout.apt Wed Oct 19 12:04:48 2005
@@ -8,6 +8,13 @@
Introduction to the Standard Directory Layout
+ Having a common directory layout would allow for users familiar with one Maven project to immediately feel
+ at home in another Maven project. The advantages are analogous to adopting a site-wide look-and-feel.
+
+ The next section documents the directory layout expected by Maven and the directory layout created by
+ Maven. Please try to conform to this structure as much as possible; however, if you can't these settings can
+ be overridden via the project descriptor.
+
*--------------------------+-----------------------------------------------+
| src/main/java | Application/Library sources
*--------------------------+-----------------------------------------------+
@@ -27,3 +34,30 @@
*--------------------------+-----------------------------------------------+
| src/site | Site
*--------------------------+-----------------------------------------------+
+| LICENSE.txt | Project's license
+*--------------------------+-----------------------------------------------+
+| README.txt | Project's readme
+*--------------------------+-----------------------------------------------+
+
+ At the top level files descriptive of the project: a <<<pom.xml>>> file (and any properties,
+ <<<maven.xml>>> or <<<build.xml>>> if using Ant). In addition, there are textual documents meant
+ for the user to be able to read immediately on receiving the source: <<<README.txt>>>,
+ <<<LICENSE.txt>>>, etc.
+
+ There are just two subdirectories of this structure: <<<src>>> and <<<target>>>. The only other
+ directories that would be expected here are metadata like <<<CVS>>> or <<<.svn>>>, and any
+ subprojects in a multiproject build (each of which would be laid out as above).
+
+ The <<<target>>>directory is used to house all output of the build.
+
+ The <<<src>>> directory contains all of the source material for building the project, its site and so on.
+ It contains a subdirectory for each type: <<<main>>> for the main build artifact, <<<test>>> for
+ the unit test code and resources, <<<site>>> and so on.
+
+ Within artifact producing source directories (ie. <<<main>>> and <<<test>>>), there is one
+ directory for the language <<<java>>> (under which the normal package hierarchy exists), and one for
+ <<<resources>>> (the structure under which is copied to the target classpath given the default resource definition).
+
+ If there are other contributing sources to the artifact build, they would be under other subdirectories: for
+ example <<<src/main/antlr>>> would contain Antlr grammar definition files.
+
Added: 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=326651&view=auto
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt (added)
+++ maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt Wed Oct 19 12:04:48 2005
@@ -0,0 +1,11 @@
+ ------
+ Guide to uploading artifacts to Ibiblio
+ ------
+ Jason van Zyl
+ ------
+ 12 October 2005
+ ------
+
+Guide to uploading artifacts to Ibiblio
+
+ In progress.
Propchange: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/components/trunk/maven-site/src/site/apt/guides/mini/guide-ibiblio-upload.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/components/trunk/maven-site/src/site/apt/guides/tail.txt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/tail.txt?rev=326651&r1=326650&r2=326651&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/tail.txt (original)
+++ maven/components/trunk/maven-site/src/site/apt/guides/tail.txt Wed Oct 19 12:04:48 2005
@@ -8,7 +8,13 @@
* {{{../plugins/index.html}Available Plug-ins}}
* {{{../developers/mojo-api-specification.html}Mojo API}}
+
+ * {{{..//mojo-api-specification.html}Mojo API}}
* {{{../ant-tasks.html}Ant Tasks}}
+
+ * {{{../glossary.html}Glossary}}
+
+ * {{{../maven-conventions.html}Maven Conventions}}
[]