You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Alex Wood (JIRA)" <ji...@codehaus.org> on 2005/08/18 00:29:08 UTC

[jira] Created: (MAVEN-1667) Inconsistency in Project Structure Recommendations

Inconsistency in Project Structure Recommendations
--------------------------------------------------

         Key: MAVEN-1667
         URL: http://jira.codehaus.org/browse/MAVEN-1667
     Project: Maven
        Type: Bug
  Components: documentation  
 Reporter: Alex Wood
    Priority: Minor


The Maven Directory Layout page (http://maven.apache.org/reference/dirlayout.html) notes for the "src" directory that

"The code may be placed into separate source code directories by language, as in src/java/ and src/php/ for source code in the Java and PHP languages respectively. The separation into directories according to function (src/share, src/core, src/web) is currently not supported by Maven. It is highly recommended that sub-directories be used under src/."

The Maven Conventions Page (http://maven.apache.org/reference/conventions.html) advises that projects should follow another directory structure:
src/main/$LANGUAGE, src/test/$LANGUAGE, src/site/xdocs, etc.  To me this seems to contradict the statement that Maven doesn't support separation into directories according to function.  The examples given of structures to avoid (src/core and src/web) match closely to what's encouraged elsewhere (src/main and src/site).

The directory layout page is marked as being for v1.0.2, but the conventions page is not marked with a version.  If the conventions are different for different versions, clearer labeling is needed.  If the conventions are constant across versions, then the documentation should be changed so that it is not contradicting itself.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MAVEN-1667) remove old html files from the site

Posted by "Alex Wood (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MAVEN-1667?page=comments#action_44751 ] 

Alex Wood commented on MAVEN-1667:
----------------------------------

It's actually the first item returned by google if you search for 'maven 
"directory structure"'.  As far as I recall, I didn't navigate to it 
from within the site.
------------------
Regards,
Alex

> remove old html files from the site
> -----------------------------------
>
>          Key: MAVEN-1667
>          URL: http://jira.codehaus.org/browse/MAVEN-1667
>      Project: Maven
>         Type: Bug
>   Components: documentation
>     Reporter: Alex Wood
>     Priority: Minor
>      Fix For: 1.1-beta-2

>
>
> The Maven Directory Layout page (http://maven.apache.org/reference/dirlayout.html) notes for the "src" directory that
> "The code may be placed into separate source code directories by language, as in src/java/ and src/php/ for source code in the Java and PHP languages respectively. The separation into directories according to function (src/share, src/core, src/web) is currently not supported by Maven. It is highly recommended that sub-directories be used under src/."
> The Maven Conventions Page (http://maven.apache.org/reference/conventions.html) advises that projects should follow another directory structure:
> src/main/$LANGUAGE, src/test/$LANGUAGE, src/site/xdocs, etc.  To me this seems to contradict the statement that Maven doesn't support separation into directories according to function.  The examples given of structures to avoid (src/core and src/web) match closely to what's encouraged elsewhere (src/main and src/site).
> The directory layout page is marked as being for v1.0.2, but the conventions page is not marked with a version.  If the conventions are different for different versions, clearer labeling is needed.  If the conventions are constant across versions, then the documentation should be changed so that it is not contradicting itself.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MAVEN-1667) remove old html files from the site

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MAVEN-1667?page=all ]

Brett Porter updated MAVEN-1667:
--------------------------------

    Fix Version: 1.1-beta-2
        Summary: remove old html files from the site  (was: Inconsistency in Project Structure Recommendations)

> remove old html files from the site
> -----------------------------------
>
>          Key: MAVEN-1667
>          URL: http://jira.codehaus.org/browse/MAVEN-1667
>      Project: Maven
>         Type: Bug
>   Components: documentation
>     Reporter: Alex Wood
>     Priority: Minor
>      Fix For: 1.1-beta-2

>
>
> The Maven Directory Layout page (http://maven.apache.org/reference/dirlayout.html) notes for the "src" directory that
> "The code may be placed into separate source code directories by language, as in src/java/ and src/php/ for source code in the Java and PHP languages respectively. The separation into directories according to function (src/share, src/core, src/web) is currently not supported by Maven. It is highly recommended that sub-directories be used under src/."
> The Maven Conventions Page (http://maven.apache.org/reference/conventions.html) advises that projects should follow another directory structure:
> src/main/$LANGUAGE, src/test/$LANGUAGE, src/site/xdocs, etc.  To me this seems to contradict the statement that Maven doesn't support separation into directories according to function.  The examples given of structures to avoid (src/core and src/web) match closely to what's encouraged elsewhere (src/main and src/site).
> The directory layout page is marked as being for v1.0.2, but the conventions page is not marked with a version.  If the conventions are different for different versions, clearer labeling is needed.  If the conventions are constant across versions, then the documentation should be changed so that it is not contradicting itself.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MAVEN-1667) Inconsistency in Project Structure Recommendations

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MAVEN-1667?page=comments#action_44720 ] 

Brett Porter commented on MAVEN-1667:
-------------------------------------

where was dirlayout.html linked from? It is not part of the current site.

> Inconsistency in Project Structure Recommendations
> --------------------------------------------------
>
>          Key: MAVEN-1667
>          URL: http://jira.codehaus.org/browse/MAVEN-1667
>      Project: Maven
>         Type: Bug
>   Components: documentation
>     Reporter: Alex Wood
>     Priority: Minor

>
>
> The Maven Directory Layout page (http://maven.apache.org/reference/dirlayout.html) notes for the "src" directory that
> "The code may be placed into separate source code directories by language, as in src/java/ and src/php/ for source code in the Java and PHP languages respectively. The separation into directories according to function (src/share, src/core, src/web) is currently not supported by Maven. It is highly recommended that sub-directories be used under src/."
> The Maven Conventions Page (http://maven.apache.org/reference/conventions.html) advises that projects should follow another directory structure:
> src/main/$LANGUAGE, src/test/$LANGUAGE, src/site/xdocs, etc.  To me this seems to contradict the statement that Maven doesn't support separation into directories according to function.  The examples given of structures to avoid (src/core and src/web) match closely to what's encouraged elsewhere (src/main and src/site).
> The directory layout page is marked as being for v1.0.2, but the conventions page is not marked with a version.  If the conventions are different for different versions, clearer labeling is needed.  If the conventions are constant across versions, then the documentation should be changed so that it is not contradicting itself.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MAVEN-1667) remove old html files from the site

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MAVEN-1667?page=comments#action_44723 ] 

Brett Porter commented on MAVEN-1667:
-------------------------------------

before removing these, I will create a custom 404 page. infrastructure pinged to see if this is possible.

> remove old html files from the site
> -----------------------------------
>
>          Key: MAVEN-1667
>          URL: http://jira.codehaus.org/browse/MAVEN-1667
>      Project: Maven
>         Type: Bug
>   Components: documentation
>     Reporter: Alex Wood
>     Priority: Minor
>      Fix For: 1.1-beta-2

>
>
> The Maven Directory Layout page (http://maven.apache.org/reference/dirlayout.html) notes for the "src" directory that
> "The code may be placed into separate source code directories by language, as in src/java/ and src/php/ for source code in the Java and PHP languages respectively. The separation into directories according to function (src/share, src/core, src/web) is currently not supported by Maven. It is highly recommended that sub-directories be used under src/."
> The Maven Conventions Page (http://maven.apache.org/reference/conventions.html) advises that projects should follow another directory structure:
> src/main/$LANGUAGE, src/test/$LANGUAGE, src/site/xdocs, etc.  To me this seems to contradict the statement that Maven doesn't support separation into directories according to function.  The examples given of structures to avoid (src/core and src/web) match closely to what's encouraged elsewhere (src/main and src/site).
> The directory layout page is marked as being for v1.0.2, but the conventions page is not marked with a version.  If the conventions are different for different versions, clearer labeling is needed.  If the conventions are constant across versions, then the documentation should be changed so that it is not contradicting itself.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org