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

Jan Groth (JIRA) jira-events at lists.jboss.org
Mon Mar 8 16:25:58 EST 2010

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

Jan Groth commented on JBSEAM-4585:

I already proposed the sub-forum idea a couple of times, and pretty much got a similar answer all the time. :-(
I completely disagree with the opinion that moderating a forum is a waste of time. THIS here is a JIRA ticket concerning the - undoubtfully needed - community improvements. I find that supporting the community cannot be a waste of time _by_definition_, and I find that moving topics from one sub-forum to another can hardly be too much work for a moderator - besides I gladly volounteer to help out... 
I spoke with friends and colleages and I am myself moderator of a German Seam forum: All I can say is that this is a much requested, natural feature of a forum.
One last argument: Have a look around around and pinpoint me to a single examplary (and comparable) forum where 11.244 topics and 42.698 posts simply mix up in a huge bag. 

I took your question as an opportunity to brainstorm with colleagues. This came out:

(*) "have a better knowledge base, integrate code snippets" (my personal favorite) - like the python guys do it here: http://www.djangosnippets.org/, but better search options. I find this an extremely useful instrument for all types of users, from beginners to core developers, and I do miss this option a lot in the Seam context. BTW: A tag cloud would be a very intuitive way to browse the content.

(*) "(even) better documentation for the seam examples that ship with the framework" - the distribution comes with a lot of good examples. In the documentation just a few are explained in greater detail, some others are briefly mentioned, some others are not referred to at all. Having more examples (and the underlaying concepts) explained would make a great impact for a lot of developers.

(*) "provide a guided tour to start with seam" - something with the character of a tour. We could make the life of beginners even more easy if we'd provided a navigation entry "guided tour" which keeps the user busy for a couple of hours. "download the framework", "set up the AS", "run the first examples", "get the key concepts", something like this. Most information is already available, it's just a matter of presenting it in a "tour concept"

(*) "provide a maven archetype for seam" - just like we did with Weld :-)

(*) "diversify the search functionality" - present different hits from different categories. example: search term "XYZ": show top 5 hits from forums, then top 5 from the examples, then from the knowledge base, then code snippets...

(*) "ranking system for forum users" - the already existing system where users get a rating could be extended (eg: bronze - silver - gold - platinum). beginners could then easier be distinguished from expert users, and topics could easier be categorized. users would achieve a certain reputation over the time, the better the reputation is, the more weight their answers (should) have....

> 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.)
> * 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.
> *** No clear place to get started using CDI/Weld/EE6 functionality - Persistence, Transactions, CDI, all need clear getting started information and tutorials.
> * 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


More information about the seam-issues mailing list