The following comment has been added to this issue:
Author: Geoffrey
Created: Sat, 11 Sep 2004 7:42 AM
Body:
Users sometimes get confused with the developper documentation.
Especially for end-user projects such as a text processer, this is true.
I believe the site plugin should by default have the notion of "user documentation"
and "developper documentation" and clearly seperate them. Also the generated reports
should have a notion to which they belong (checkstyle, FAQ).
Every project has people just using it and other improving it too.
The developper documentation (conventions, UML diagrams, etc) belongs with the
generated developper reports, while the user generated FAQ's can be linked from the
user docs.
This would make it easy to implement a property includeDevelopperDocumentation for
end-user releases etc.
The catch here is that there could be 2 FAQ's generated: one for users and one for
developpers.
---------------------------------------------------------------------
View this comment:
http://jira.codehaus.org/browse/MAVEN-1287?page=comments#action_23977
---------------------------------------------------------------------
View the issue:
http://jira.codehaus.org/browse/MAVEN-1287
Here is an overview of the issue:
---------------------------------------------------------------------
Key: MAVEN-1287
Summary: documentation ideas
Type: Task
Status: Open
Priority: Blocker
Original Estimate: Unknown
Time Spent: Unknown
Remaining: Unknown
Project: maven
Components:
documentation
Fix Fors:
1.0.1
Versions:
1.0-rc3
Assignee: Brett Porter
Reporter: Brett Porter
Created: Wed, 19 May 2004 9:54 AM
Updated: Sat, 11 Sep 2004 7:42 AM
Due: Mon, 31 May 2004 12:00 AM
Description:
- something like http://xstream.codehaus.org/versioning.html
- a key for the new xdoc symbols is needed (And must be optional). Maybe just above
the logo?
- refer to Pete Kazmier's previous work and perhaps torque for good examples:
tutorial, guides, howto, reference.
---------------------------------------------------------------------
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: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
