Tour de Comms Wiki
By joesciallo on Apr 21, 2008
Now that we have this new documentation approach called the CommSuite Wiki, how are you supposed to use it, what routes can you follow to get to the information you need, what are the paths to take to get to where you want to go, and what's different about this approach than with previous Comms releases?
With that in mind, here's a quick tour of the CommSuite Wiki.
General OverviewWe're using panels to organize content on the Comms Wiki Landing Page (the top-level page). These panels present different views of the available information; different pathways, if you will, depending on how you like to access information. The Landing Page also gives links to previous versions of Comms docs so that you don't have to go to docs.sun.com, where those older docs are located.
About This Wiki Panel
In some ways, this is the obligatory stuff every site needs: purpose of this wiki, how to contact us, and so on. Use the Recently Updated Pages link to see at a glance the most recent changes made to the Comms Wiki.
The How-To's panel presents Comms how to information in a product life-cycle type format. That is, we envision six high-level areas for your Comms deployment, starting with Planning and ending in Troubleshooting. Note: Wherever possible, we use Confluence labels and macros to automatically create the content of these pages, ensuring that new pages get added to these indexes on the fly.
This panel presents a traditional view of the Comms information, organized along the lines of manuals, guides, and the like. Notice the Work-in-Progress Documentation. In this new model, we will be presenting and sharing the information as soon as we have something, even if we are still dotting the i's and crossing the t's; the thought being, the sooner we can get info in your hands, even if it still needs a little work, the better. (And, being a wiki, the entire Comms community can have the chance to enhance and add to the information as well.)
Quick Picks Panel
This panel is a compendium of assorted links that we think need special attention or highlighting. Additionally, if we see that certain pages are being accessed more frequently, we'll update this panel with the links to those pages. Of note in this panel: the Indexes and FAQ pages use labels and macros, like the How-to pages, to automatically generate content.
Searching for Information on the Comms Wiki
Searching the Comms wiki is actually quite easy and fast, in my opinion. Every Comms wiki page contains the Searching Sun Java Communications Suite bar. Simply begin typing what you are looking for. As the above screenshot shows, you are presented with a list of matches, even before you press the Enter key. You can pick a link from this list, or press Enter to get even more search options.
Tip: Instead of using the wiki breadcrumbs to navigate back and forth to the Landing page, use the Search bar to quickly locate what you need.