Friday Oct 03, 2008

How to Be a GlassFish Doc Reviewer

Mark your calendars! Final review of the GlassFish v3 Prelude documentation is scheduled for October 6th through October 10th.

Members of the GlassFish documentation team will be asking subject matter experts individually to review sections of the documentation that apply to their area of expertise. If you are asked to review a particular section of the documentation, or if you are interested in GlassFish v3 Prelude documentation, please set aside time for this review. The quality of your reviews has a major effect on the overall quality of the documentation.

Stay tuned for details about how to obtain the drafts for review and how to provide feedback. Those details will be posted on this blog and also sent to the appropriate GlassFish mailing lists such as dev, users, and docs. Thanks in advance for your attention to these reviews. They're really important.

Friday Aug 08, 2008

Participate in FishCAT

You're invited to participate in FishCAT, the new community testing program that was recently announced by the GlassFish Quality Community. FishCAT kicks off with GlassFish v3 Prelude, and documentation reviews are an important part of the program. See the FishCAT page for details about the program and how to apply, and the documentation review page for details about documentation reviews. Submit your application right away if you're interested. The deadline for applications is August 15th, 2008.

Quality documentation is vital to a quality product. By participating in FishCAT and reviewing documentation, you can directly improve the quality of the GlassFish v3 Prelude release and greatly benefit GlassFish users and developers. FishCAT is just one way to participate in GlassFish documentation. For a list of others, see the documentation home page.

Thursday Jul 17, 2008

GlassFish User FAQ Now in Japanese

As announced by Ming, the GlassFish User FAQ has been translated into Japanese. This great work was done by the Japanese GlassFish community, in conjunction with the G11n team. The community is now translating the GlassFish Developer FAQ into Japanese. The User FAQ project was also submitted as a GlassFish Awards Program (GAP) entry. Because the User and Developer FAQs are dynamic and change often as new entries are added and existing entries are updated, the Japanese community will monitor the FAQs and make changes to the Japanese versions as necessary to keep them in sync with the English versions (or as close as possible).  

This is just one example of the translation work being done by the global GlassFish community. Community members are also translating the User FAQ into Chinese, Spanish, and Italian. Many thanks for all of these efforts, which are of great benefit to GlassFish users and developers around the world. Translation of the FAQs into other languages is also needed. If you'd like to get involved, see Translating User and Developer FAQs. Questions or comments? Contact the and mailing lists.

Monday Mar 24, 2008

Get Your GAP Entries In

Just a reminder about the GlassFish Awards Program (GAP), which was mentioned in a previous post and which offers prize money for innovation in a number of areas, including documentation. The deadline is June 30th but that doesn't mean you should wait until the last minute to get your entries in — you definitely shouldn't! You're encouraged to submit your entries now, even if they aren't completely finished, and then resubmit later as you make more progress.

Read this post on The Aquarium, then make plans to get your submissions in sooner rather than later. A lot of money is up for grabs, and it's a great opportunity for recognition, too.

Wednesday Mar 12, 2008

What's New in GlassFish Documentation?

What's new in GlassFish documentation? Quite a bit, actually! The focus is on community participation. Take a look at what's happening, then get involved:

  • GlassFish Documentation Home Page. The documentation home page on the GlassFish community site has been completely revised and lists the many ways you can get involved with GlassFish docs. Explore the links and think about how you'd like to participate.
  • GlassFish Community Docs Page. A new Community Docs page has been created on the GlassFish wiki and focuses on the specifics of community doc contributions. The page will grow as the community grows and momentum builds. It's time to make that happen.
  • GlassFish Migration Guide. A new Migration Guide has been posted on the GlassFish wiki and is ready for community contribution. The guide is part of the Migrate To GlassFish project and was recently announced and blogged about. Why not add your expertise to this and other GlassFish docs?

So explore the new pages, decide where you'd like to plug in, then do so! Contact the doc team or leave a comment here if you have any questions about how to get involved or suggestions about anything you see in the pages and docs mentioned above. We really do want and need your feedback. Writers by nature have very tough skins.

Wednesday Feb 13, 2008

Brainstorming for GlassFish v3 User Tasks: Facilitating a Session

The final installment in the series explaining how to brainstorm for user tasks.[Read More]

Wednesday Feb 06, 2008

Brainstorming for GlassFish v3 User Tasks: Preparing to Facilitate a Session

A summary of the process for preparing to facilitate a task brainstorming session.[Read More]

And the Award for Best Documentation Goes To...

Oh, that's right. I can't win. But you can if you're not a Sun employee and if you meet a few other restrictions. Yes, it's true. Fame and fortune can be yours simply by writing documentation.

It's all part of the Community Innovation Awards Program, which is now open for submissions. GlassFish is one of the participating open source projects and monetary awards (money!) will be given in the categories of Bug Reports and Contributions. That Contributions category includes documentation. See the GlassFish Awards Program for complete details. The last day to submit entries is June 30th, 2008. Winners will be announced on or about August 15th, 2008.

Thursday Jan 31, 2008

Brainstorming for GlassFish v3 User Tasks: What and Who

A description of the process for identifying the scope of and key participants in task brainstorming sessions[Read More]

Friday Dec 21, 2007

Taking Stock of Docs: What Worked and What Didn't?

The end of the year is a good time to take stock: What worked, what didn't, what to focus on going forward.

The Application Server docs team tried some new things this past year and we'd like to know how you, our customers and documentation consumers, feel about them: What worked and what didn't?

A few items to consider:

  • Documentation Comments Wiki – Do you know about it? Did you use it? Was it helpful? The doc comments wiki is a great mechanism for providing feedback on the docs (and now we'd like feedback on the feedback mechanism!).

  • User and Developer FAQs – Did you use or contribute to either of these? Are they helpful? What would make them better? These FAQs are definitely a community effort, so if you have something to contribute, please do.

  • Documentation Mailing List – Are you on it? If not, why not join? If you're interested in documentation and in building the documentation community, this is great place to get the conversation started. You can join the list from the GlassFish mailing lists page. The page isn't in alphabetical order so you'll need to scroll way down (the infrastructure apparently orders the list based on age, oldest to newest).

  • Documentation Planning Meetings – Now is the time to plan for Application Server 10 / GlassFish v3 and we need your input! We've been holding a series of informal planning meetings to which the community has been invited but so far it's been just us doc folks. Are you aware of these meetings? What's been stopping you from attending? What would make it more likely that you'd attend and get involved (different topics, different time, more advance notice, clearer understanding of what's being asked of you)? What would you like to see for docs? How should they be developed and delivered? So many questions! These planning meetings will start up again in January. Details can be found on the meetings page. Please join us!

That's just a sampling of what's been happening in the wonderful world of Application Server docs this past year (in addition to providing complete documentation sets for the Application Server 9.1 / GlassFish v2 and Application Server 9.1 Update 1 / GlassFish v2 UR1 releases!). So to ask the question again: What worked and what didn't? We'd love to hear your answer to that question and to the questions asked in the points above. Please leave a comment here or contact the doc team through the documentation mailing list. We'll be out for the holiday break but will respond to any and all comments when we get back, refreshed and rejuvenated. Thanks in advance, and happy holidays to anyone celebrating them right about now!

Wednesday Nov 21, 2007

GlassFish Developer FAQ and Other FAQ News

I've been working on a few things related to GlassFish FAQs and wanted to bring you up to date.

A revised GlassFish Developer FAQ is now available on the GlassFish Wiki and ready for contributions. It doesn't contain a lot of FAQs at this point, which is where you come in. As with the GlassFish User FAQ, this Developer FAQ is a community effort and a continual work in progress. What's available now is just a start. Please contribute FAQs of your own and make improvements and updates to what's already there.

Content in this new Developer FAQ came from several places – some from the old Developer FAQ on the GlassFish Wiki (that FAQ has been deprecated), and some from the legacy GlassFish FAQ on the Community site. The ultimate goal is to consolidate all such information in the User and Developer FAQs on the wiki. Links on the Community site will then point to these FAQs, and the legacy GlassFish FAQ will essentially go away. This consolidation work isn't quite as simple as it might sound but it's well underway and nearing completion. Please bear with us.

A few other items of note:

  • I've created a GlassFish Wiki FAQ for – you guessed it – frequently asked questions related to the use of the GlassFish Wiki. It's pretty bare-bones at the moment so feel free to add questions of your own.

  • Which reminds me: Have I mentioned that community involvement and contribution are critical to making these FAQs at all useful? =) The FAQs now all have Wishlist sections such as this one in the User FAQ. If you have a question you'd like to see answered but don't have the answer yourself, add it to the list. And all you experts out there – if you know the answer to one or more of these wishlist questions, please provide it!

As always, feedback and comments are most welcome. Let me know what you think about these FAQs – what you like and don't like, what would make them more useful, what keeps you from contributing, those types of things. That would be really good to know.

Friday Nov 02, 2007

GlassFish v3 Documentation Planning

Now is the time to plan for GlassFish v3 documentation and your input is needed! Just as features and enhancements are now being discussed from an engineering perspective, what's on your wishlist for docs?

All members of the GlassFish community are invited to join the documentation team for discussions about GlassFish v3 documentation. The first discussion takes place Monday, November 5th at 8:30 AM Pacific, with other discussions to follow. Dial-in information and other details can be found on the GlassFish v3 Documentation Meetings page on the GlassFish wiki.

If you can't attend the meeting, you can still participate in the discussion through the mailing list. You can subscribe to this list through the GlassFish Community mailing lists page.

Thanks in advance for your input. Community participation is critical as we brainstorm this next generation of GlassFish documentation. We look forward to talking with you.

Wednesday Oct 17, 2007

Glassfish 9.1 Error Message Reference Wiki

Request for community input: Glassfish 9.1 Error Message Wiki

[Read More]

Monday Sep 17, 2007

New Release: GlassFish v2. Read All About It!

Today, Sun announced the immediate availability of GlassFish V2 and its commercially supported counterpart, the Sun JavaTM System Application Server 9.1.

The user documentation provides comprehensive instructions for installing, setting up, and maintaining GlassFish V2 and Sun Java System Application Server 9.1.

In this documentation, you'll find detailed information about how to use new features of this release, such as:

On behalf of the Application Server documentation team, I would like to thank the members of the GlassFish community for their contributions to the documentation.

Friday Sep 14, 2007

GlassFish User FAQ

The GlassFish User FAQ is now available on GlassFish Wiki.

The User FAQ is a relatively new creation and contains frequently asked questions that pertain to the use of GlassFish. As you can see, it's a work in progress, and that's where you come in. Contributions are invited, welcomed, and needed! Go to the URL listed above and see how you can get involved.


The scoop on GlassFish documentation and more!


« July 2016