Help

If you've ever programmed in PHP, Ruby, Perl, Groovy, and probably others, then you know how nice it is to have a central, official space for reference documentation and inline community feedback.

This is something that has sorely been missing from the JEE community, and something that has caused many disparate websites to attempt putting forward a weak effort in providing useful documentation -- you leave the community part aside to think that this is a good thing for any open-source technology.

A successful open-source community documentation initiative has:

  • Comprehensive documentation provided on a central, official website (http://seamframework.org)
  • Inline comments and user feedback.
  • The most common paths on the website are the most visible, intuitive paths.
  • Fluent navigation and document hierarchies. (The URL matches the Breadcrumbs matches the content. If users get lost, users give up.)
  • Accurate and relevant official information, well vetted information.

I'm sure there is more, but that's what I have at the top of my head.

Making progress happen:

In kick-starting my (hopefully long) tenure with Red Hat, I'm focusing on improving community documentation for the Seam Framework, and for Java EE as a whole. I've started by updated the Seam Framework website to more clearly display the links to Seam and Weld JIRAs; you previously had to do a little digging.

All of my efforts can be tracked here: https://jira.jboss.org/jira/browse/JBSEAM-4585

Please, I ask if you find any outstanding problems, or points of pain with the Seam or Weld documentation, to add it to this Jira. If you can't, then comment here and I'll see that it's addressed.

SeamFramework.org needs work, and I do think that the community really belongs on jboss.org, in order to fully get credit for their hard work and great achievements. Jboss.org also provides much of the functionality that I'm looking for in a community management tool, but we'll see what everyone wants ;)

Happy communities make happy software!

5 comments:
 
05. Mar 2010, 08:55 CET | Link

Good to see someone will work on documentation! PS: Your name is not listed on the Bloggers sidebar... ;)

ReplyQuote
 
05. Mar 2010, 11:15 CET | Link
Grzegorz Grzybek

I'd like to add one more thing - not directly related to documentation but rather to source code:

  • one (maybe mirrored) reliable source of maven artifacts (jar, source, pom)

It's not a case with some bassic JEE jars (servlet-api, jsp, el, ...)

regards Grzegorz Grzybek

 
05. Mar 2010, 13:30 CET | Link
Pardeep
This is a good initiative and must for one global reference!

Pardeep
 
07. Mar 2010, 23:28 CET | Link
Grzegorz Grzybek wrote on Mar 05, 2010 05:15:
I'd like to add one more thing - not directly related to documentation but rather to source code:
  • one (maybe mirrored) reliable source of maven artifacts (jar, source, pom)
It's not a case with some bassic JEE jars (servlet-api, jsp, el, ...) regards Grzegorz Grzybek

Grzegorz, that is definitely an initiative that Red Hat is pursuing aggressively. We recognize what a barrier this places on adoption of Java EE--exactly the type of barrier that we seek to remove.

You should note that progress has been made recently with Sonatype's effort to merge the java.net repository artifacts into central.

 
08. Mar 2010, 13:56 CET | Link
Grzegorz Grzybek | gr.grzybek(AT)gmail.com

I appreciate what JBoss and Sonatype do to make JavaEE more elegant and organized.

I've also commented on this subject at http://www.restfusion.com/blog/2010/02/jee-sdk-loathe-it-or-ignore-it-you-cant-like-it/comment-page-1/#comment-33.

Generally I'm frustrated that there is no official javax.servlet:servlet-api:3.0 artifact, I've found it at org.glassfish:javax.servlet:3.0. Also there are no sources for JavaEE 6 APIs and classes are packaged in an all-in-one fashion.

I wish Sun (Oracle) created better repository, both for maven artifacts and for sources (there are more CVS tags for e.g. JAX-WS than pages in EJB specification...)

So - I hope that with JBoss and Sonatype's effort we'll live to see clear and well organized repository of JavaEE.

regards

Post Comment