[seam-issues] [JBoss JIRA] Commented: (JBSEAM-4585) Community documentation updates and improvements.

[Dan Allen (JIRA)]

    [ https://jira.jboss.org/jira/browse/JBSEAM-4585?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12518197#action_12518197 ] 

Dan Allen commented on JBSEAM-4585:
-----------------------------------

I'll provide some usability feedback to help the cause...

I never start with sfwk.org. The home page has content which is somewhat dynamic, and has 0 convenient links. More times than not I go to Google, search for what I want, click to the wrong page on Seam framework, navigate around a bit more and eventually get to what I want...then I realize that I need to login...and finally I am editing the page I need to edit. So painful.

Plus, you go to the Downloads or Documentation page and you are forced to really concentrate hard on which link will actually take you to the documentation that you expect. I really like the idea on javaseverfaces.org (as simple as it may be) that you just have one link that takes you the most recent documentation. Then, if you really want to get a different version, you can go to the detailed page with all the links. Actually, it would be even better to have a page in between...but I'm getting too detailed.

I really don't understand why we have to present both HTML and HTML single either...who the hell cares which one? Just make HTML the default and if someone wants the HTML single, then we can put a link somewhere else, less obvious, that gets them there. (If you think the default should be the other way around, then fine, just pick one).

> Community documentation updates and improvements.
> -------------------------------------------------
>
>                 Key: JBSEAM-4585
>                 URL: https://jira.jboss.org/jira/browse/JBSEAM-4585
>             Project: Seam
>          Issue Type: Task
>          Components: Documentation Issues
>    Affects Versions: The future
>            Reporter: Lincoln Baxter III
>            Priority: Optional
>             Fix For: The future
>
>
> As part of an initiative to improve the experience for new and existing developers, community members getting involved with Seam and Weld, I am documenting a set of improvements to be made to the current state user-facing http://seamframework.org and related documentation.
> This task serves as a running list of inconsistencies, improvement areas, and erroneous information provided on SWFK.org (and related.)
> ==INCOMPLETE==
> * http://seamframework.org/Community/GettingStartedDevelopingTheSeamFramework -- page still references version 2.0 of Seam for new development, which is now a lie
> * http://seamframework.org/Download/SeamDownloads#H-SeamSVNRepository contains repo URLs that are now broken for SCM checkout.
> ==COMPLETED==
> * Too hard to find JIRA links -- added JIRA links to sidenav -- Lincoln Baxter

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