[jira] Updated: (MAVEN-1056) separate release-independant documentation

[ji...@codehaus.org]

The following issue has been updated:

    Updater: Brett Porter (mailto:brett@codehaus.org)
       Date: Sat, 3 Apr 2004 10:03 PM
    Changes:
             environment changed to 
             Fix Version changed to 1.1
             Fix Version changed from 1.0-rc3
    ---------------------------------------------------------------------
For a full history of the issue, see:

  http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-1056&page=history

---------------------------------------------------------------------
View the issue:
  http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-1056

Here is an overview of the issue:
---------------------------------------------------------------------
        Key: MAVEN-1056
    Summary: separate release-independant documentation
       Type: Task

     Status: Unassigned
   Priority: Major

 Original Estimate: Unknown
 Time Spent: Unknown
  Remaining: Unknown

    Project: maven
 Components: 
             documentation
   Fix Fors:
             1.1

   Assignee: 
   Reporter: Brett Porter

    Created: Wed, 26 Nov 2003 5:28 PM
    Updated: Sat, 3 Apr 2004 10:03 PM

Description:
We need to separate the documentation that is release independant (or applies to multiple releases) to a separate "subproject" that can be deployed and versioned appropriately. This would mean that the current site can reflect the latest release, but have up to date news, FAQs, articles, etc.

maven.apache.org/1.0-rc2/ - generated site with reports, javadoc, installation instructions, download links
maven.apache.org/1.1-SNAPSHOT/ - current CVS HEAD, as above for current.

<siteDirectory>/www/maven.apache.org/${pom.currentVersion}</siteDirectory>

maven.apache.org/ - home page, navigation that refers to the last release, and has documentation such as users guide, FAQs etc. While it may contain 1.1 documentation, this must be clearly denoted

The same approach should be taken for the plugins.

<siteDirectory>/www/maven.apache.org/reference/plugins/ear/${pom.current
Version}</siteDirectory>

The navigation can include links to other versions at the top. At the point where a version is removed from there, it should also be archived and removed from /www/maven.apache.org

Setting up the navigation for the main site and making it consistent with subsections could be tedious and tricky - it may be good to have the xdoc-plugin support this in some fashion.




---------------------------------------------------------------------
JIRA INFORMATION:
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

If you want more information on JIRA, or have a bug to report 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