You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by je...@jakarta.apache.org on 2004/06/28 22:08:54 UTC
[jira] Created: (JS2-83) Site Documentation, Architectural Overview
Message:
A new issue has been created in JIRA.
---------------------------------------------------------------------
View the issue:
http://issues.apache.org/jira/browse/JS2-83
Here is an overview of the issue:
---------------------------------------------------------------------
Key: JS2-83
Summary: Site Documentation, Architectural Overview
Type: Task
Status: Unassigned
Priority: Major
Project: Jetspeed 2
Components:
Site Documentation
Fix Fors:
2.0-dev/cvs
Versions:
2.0-dev/cvs
Assignee:
Reporter: David Sean Taylor
Created: Mon, 28 Jun 2004 1:07 PM
Updated: Mon, 28 Jun 2004 1:07 PM
Due: Tue, 29 Jun 2004 12:00 AM
Description:
Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/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: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org
[jira] Assigned: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Sean Taylor (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=all ]
David Sean Taylor reassigned JS2-83:
------------------------------------
Assign To: David Le Strat (was: David Sean Taylor)
DLS has signed up to lead on this issue.
We all need to help out.
Please sign up to help DLS with this task:
Profiler - David
PageMan - Randy
Getting Started - Ron Wheeler
....
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-dev/cvs
> Reporter: David Sean Taylor
> Assignee: David Le Strat
> Fix For: 2.0-dev/cvs
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Resolved: (JS2-83) Site Documentation, Architectural
Overview
Posted by "Ate Douma (JIRA)" <je...@portals.apache.org>.
[ https://issues.apache.org/jira/browse/JS2-83?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Ate Douma resolved JS2-83.
--------------------------
Resolution: Fixed
The current J2 website is already mostly inline with the intentions from this issue.
I'm not saying our current documentation is perfect and it certainly isn't finished.
But I don't see any point to keep this very old issue open any longer now.
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: https://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Issue Type: Task
> Components: Site Documentation
> Affects Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Fix For: 2.0-FINAL
>
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "Joshua Frausto-Yambert (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12313764 ]
Joshua Frausto-Yambert commented on JS2-83:
-------------------------------------------
Lets do both. I think we should use the wiki as a scratchboard for documentation. We can merge the wiki content into an XML/PDF document in cvs whenever we are happy with an addition. Lets keep wiki formatting to a minimum for now. Who wants to help me create a document skeleton on the wiki?
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-dev/cvs
> Reporter: David Sean Taylor
> Assignee: David Sean Taylor
> Fix For: 2.0-dev/cvs
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "Marky Goldstein (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12358124 ]
Marky Goldstein commented on JS2-83:
------------------------------------
I think the overall navigation structure is good.
I recently made a study accross many open source projects to set up a navigation as well:
http://www.itracker.org/
Have a look, although it's a site in its beginning.
More important I have the feeling that we should to some rework on the content and the content presentation for example. If I look at the Getting Started Page I get the feeling it is hard to get an overview of the Getting Started processs. So I would offer my help to improve communication and do some rework on the readability of the pages such as implementing Step Guides, Table of Contents, etc.
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Assignee: David Le Strat
> Fix For: 2.0-FINAL
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Assigned: (JS2-83) Site Documentation, Architectural
Overview
Posted by "Ate Douma (JIRA)" <je...@portals.apache.org>.
[ https://issues.apache.org/jira/browse/JS2-83?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Ate Douma reassigned JS2-83:
----------------------------
Assignee: (was: David Le Strat)
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: https://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Issue Type: Task
> Components: Site Documentation
> Affects Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Fix For: 2.0-FINAL
>
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Le Strat (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12358210 ]
David Le Strat commented on JS2-83:
-----------------------------------
Sub projects is the page generated by maven for the multiproject build. I am thinking that it may be better to have references to the components structure in the Guide to Components where we can provide better context.
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Assignee: David Le Strat
> Fix For: 2.0-FINAL
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "Ronald Wheeler (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12358260 ]
Ronald Wheeler commented on JS2-83:
-----------------------------------
I have posted the proposed getting started on http://jetspeed.artifact-software.com.
This may address some of the issues raised by Marky Goldstein which very much reflects my motifation for getting started.
These changes are being incorporated into the main documentation.
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Assignee: David Le Strat
> Fix For: 2.0-FINAL
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Sean Taylor (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12356897 ]
David Sean Taylor commented on JS2-83:
--------------------------------------
Its a never ending process :)
Im working on a presentation for ApacheCon, that work will eventually make its way back in here.
I like the UML docs you did for the security docs.
It would be nice if all the documentation had the same UML drawing styles.
How can I generate docs like yours?
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-dev/cvs
> Reporter: David Sean Taylor
> Assignee: David Sean Taylor
> Fix For: 2.0-dev/cvs
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by je...@jakarta.apache.org.
The following comment has been added to this issue:
Author: Scott T Weaver
Created: Mon, 28 Jun 2004 1:17 PM
Body:
I would prefer we publish it to the wiki, that way changes are immediate and there is a lesser chance of documentaion become "stale".
---------------------------------------------------------------------
View this comment:
http://issues.apache.org/jira/browse/JS2-83?page=comments#action_36398
---------------------------------------------------------------------
View the issue:
http://issues.apache.org/jira/browse/JS2-83
Here is an overview of the issue:
---------------------------------------------------------------------
Key: JS2-83
Summary: Site Documentation, Architectural Overview
Type: Task
Status: Unassigned
Priority: Major
Project: Jetspeed 2
Components:
Site Documentation
Fix Fors:
2.0-dev/cvs
Versions:
2.0-dev/cvs
Assignee:
Reporter: David Sean Taylor
Created: Mon, 28 Jun 2004 1:07 PM
Updated: Mon, 28 Jun 2004 1:17 PM
Due: Tue, 29 Jun 2004 12:00 AM
Description:
Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/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: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org
[jira] Updated: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Le Strat (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=all ]
David Le Strat updated JS2-83:
------------------------------
Fix Version: 2.0-FINAL
(was: 2.0-dev/cvs)
Description:
Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
was:
Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
Version: 2.0-FINAL
(was: 2.0-dev/cvs)
Environment:
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Assignee: David Le Strat
> Fix For: 2.0-FINAL
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "Ronald Wheeler (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12355994 ]
Ronald Wheeler commented on JS2-83:
-----------------------------------
There is often a problem that I have seen in packages that have both a Wiki and an Official set of docs in that they diverge over time and the user has some difficulty in figuring out which set is correct.
People may have the tendency of updating the Wiki and hoping that someone will notice the change and incorporate it into the official docs and vice versa.
A man with 2 watches does not know what time it is. (Perhaps this is an obscure reference for the young who have never owned a watch that was not controlled by a crystal movement.)
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-dev/cvs
> Reporter: David Sean Taylor
> Assignee: David Sean Taylor
> Fix For: 2.0-dev/cvs
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Le Strat (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12356904 ]
David Le Strat commented on JS2-83:
-----------------------------------
David,
I use the Omonda Live UML plugin: http://www.omondo.com/ and generate the pictures from there. The only issue with the free plugin is that you have to disconnect your project to use it. It reverse engineers the code to provide the UML view. Once I have all the diagrams i need, I put the doc together. Let me know if I can help.
Regards,
David.
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-dev/cvs
> Reporter: David Sean Taylor
> Assignee: David Sean Taylor
> Fix For: 2.0-dev/cvs
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Le Strat (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12356893 ]
David Le Strat commented on JS2-83:
-----------------------------------
Is someone currently working on the architectural overview outlined in this issue? As part of preparing for the final release, we definitely need to consolidate documentation. I suggest that the portals site should provide the consolidated documentation. Are we at a point where we can consolidate the documentation available in the WIKI? Could the folks involved in the WIKI documentation provide some guidance on how to move forward?
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-dev/cvs
> Reporter: David Sean Taylor
> Assignee: David Sean Taylor
> Fix For: 2.0-dev/cvs
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Le Strat (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12358074 ]
David Le Strat commented on JS2-83:
-----------------------------------
As part of this exercise, I would like to propose reorganizing the documentation structure a bit:
1. We should differentiate the role of the main site from the role of the subprojects sites. I propose that we locate each subproject documentation in the matching component xdocs. For instance, profiler goes into /components/profiler/xdocs. Each subproject has a PDF document that can be exported for the relevant section. The subproject documentation focus on the implementation aspects of a specific component.
The role of the main site is to provide guidance in locating the documentation for each component and to provide reference docs that cut across components.
2. I would like to reorganize the main docs navigation as follow:
Essentials
Features
Installation
Getting Started
Subprojects
Download
Binaries
Source Code
Documentation
Documentation Guides -> Links to a page with an organized list of documentation guides - The guides provide a quick list of references/links to resources around a specific topic, when necessary the guide will link to the relevant documentation in the sub project. For instance Guide to Developing Portlets, Guide to Customizing Pages, Guide to Jetspeed Pipeline, etc.
Jetspeed API
Jetspeed Plugin
Key Components
Profiler
Page Manager
Security
etc.
These are links to the subproject pages from the main page. Another option is to centralize those into a Guide to J2 Components (see above) and a better option in my opinion.
About J2
FAQ
For J1 Users
Supporting Projects (Bridge, Pluto, Apache DS, Derby, Maven, etc...)
Who Uses J2
Portlets Community
How to Help
Support
Mailing List
Bug Database
Wiki
Quality Testing
Source Code Repository
I look forward to your input. Once we have a consensus on the docs structure, I will start putting the pieces in place.
We already started to track the larger documentation effort under
http://issues.apache.org/jira/browse/JS2-389
Once we are in agreement on the structure I will create additional subtasks for people to sign up in the parent task.
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Assignee: David Le Strat
> Fix For: 2.0-FINAL
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
[jira] Commented: (JS2-83) Site Documentation, Architectural Overview
Posted by "David Sean Taylor (JIRA)" <je...@portals.apache.org>.
[ http://issues.apache.org/jira/browse/JS2-83?page=comments#action_12358207 ]
David Sean Taylor commented on JS2-83:
--------------------------------------
I think the overall new layout looks fine.
Under "Essentials", what is "Subprojects", is that the same as "Key Components"?
> Site Documentation, Architectural Overview
> ------------------------------------------
>
> Key: JS2-83
> URL: http://issues.apache.org/jira/browse/JS2-83
> Project: Jetspeed 2
> Type: Task
> Components: Site Documentation
> Versions: 2.0-FINAL
> Reporter: David Sean Taylor
> Assignee: David Le Strat
> Fix For: 2.0-FINAL
>
> Architectural Overview of Jetspeed-2, publish to Jetspeed-2 site
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org