Friday Jan 25, 2013

Unified Communications Suite: Wiki Documentation Changes

As longtime UCS-ers know, we have been providing wiki docs for many years now. One of the benefits of wiki docs is that writers can and do update content more frequently than with a static documentation environment. While this means that documentation issues get addressed more readily, it could also present a small problem in knowing when a doc (aka wiki page) has been updated. In addition, you might want to know not only that the page changed but how can you easily spot that change? Was the change cosmetic or substantive? And so on.

In the interest of making this knowledge a bit easier to come by, and to highlight the continuing work that the UCS InfoDev team is putting into our documentation, here are a few ways in which you can determine when a doc has been updated:

    • Look at the page history.
      On any page, from the Tools menu, select Page History. You then see a list of versions, dates, who made the change, and (hopefully) a comment on what was changed. For example, here is the page history for the Calendar Server 7 Administration Guide.
    • Once you are on the Page History page, you can compare versions. Click the check boxes beside the versions you want to compare then click the Compare selected versions button.
    • A quick and easy way to see what pages have changed recently is to choose Pages from the Browse menu, then select Recently Updated. You see a list of recently changed pages for the entire wiki space. This list is convenient in that you also get a view change link that takes you to a Page Comparison page, showing the changes.
    • If you have a standard Oracle ID, you can "watch" a page and be automatically notified by email when a change occurs.
      To watch a page:
      1. Log in to wikis.oracle.com.
      2. Go to the page that you want to watch.
      3. Click the Tools drop down menu and select Watch.
        When we make a change to the page, wikis.oracle.com sends you an email.
    So there you have it. You now have all the info you need to stay up-to-date on our CommSuite wiki changes.

      Monday Jan 24, 2011

      Oracle Communications Unified Communications Suite Legacy Documentation Gets a New Home

      Still looking to docs.sun.com  for Communications Suite legacy documentation and information? As of last week, this documentation has been migrated to the Oracle Documentation site. But of course, information on the Comms Wiki is still in place and continues to be the site for new documentation.

      Unfortunately, you currently need to know the direct link to find this legacy documentation. We are in the process of correcting this situation. In the meantime, use the following table to get the direct link to the legacy documentation that you are looking for. Update, 2/1/11: Added links to Japanese translations at the end of this table.



      Library Name

      New Url

      Calendar Server

      http://download.oracle.com/docs/cd/E19057-01/index.html

      iPlanet Calendar Server 2.0

      http://download.oracle.com/docs/cd/E19207-01/index.html

      iPlanet Calendar Server 2.1

      http://download.oracle.com/docs/cd/E19697-01/index.html

      iPlanet Calendar Server 5.0

      http://download.oracle.com/docs/cd/E19222-01/index.html

      iPlanet Calendar Server 5.1

      http://download.oracle.com/docs/cd/E19605-01/index.html

      Messaging Server

      http://download.oracle.com/docs/cd/E19079-01/index.html

      Oracle Communications Unified Communications Suite Version 7 Update 1

      http://download.oracle.com/docs/cd/E19143-01/index.html

      SJS Instant Messaging 7 2006Q1

      http://download.oracle.com/docs/cd/E19812-01/index.html

      Sun Calendar Server 1.0

      http://download.oracle.com/docs/cd/E19184-01/index.html

      Sun Java Communications Suite

      http://download.oracle.com/docs/cd/E19299-01/index.html

      Sun Java Communications Suite 5

      http://download.oracle.com/docs/cd/E19566-01/index.html

      Sun Java Communications Suite 6

      http://download.oracle.com/docs/cd/E19799-01/index.html

      Sun Java Communications Suite 7

      http://download.oracle.com/docs/cd/E19516-01/index.html

      Sun Java Enterprise System 2003Q4

      http://download.oracle.com/docs/cd/E19199-01/index.html

      Sun Java Enterprise System 2004Q2

      http://download.oracle.com/docs/cd/E19263-01/index.html

      Sun Java Enterprise System 2005Q1

      http://download.oracle.com/docs/cd/E19396-01/index.html

      Sun Java Enterprise System 2005Q4

      http://download.oracle.com/docs/cd/E19636-01/index.html

      Sun Java Enterprise System 5

      http://download.oracle.com/docs/cd/E19528-01/index.html

      Sun Java Enterprise System 6

      http://download.oracle.com/docs/cd/E19316-01/index.html

      Sun Java Enterprise System 7

      http://download.oracle.com/docs/cd/E19575-01/index.html

      Sun Java System Calendar Server 6 2004Q2

      http://download.oracle.com/docs/cd/E19559-01/index.html

      Sun Java System Calendar Server 6 2005Q1

      http://download.oracle.com/docs/cd/E19955-01/index.html

      Sun Java System Calendar Server 6 2005Q4

      http://download.oracle.com/docs/cd/E19305-01/index.html

      Sun Java System Calendar Server 6.0

      http://download.oracle.com/docs/cd/E19875-01/index.html

      Sun Java System Calendar Server 6.3

      http://download.oracle.com/docs/cd/E19653-01/index.html

      Sun Java System Communications Express 6.3

      http://download.oracle.com/docs/cd/E19284-01/index.html

      Sun Java System Instant Messaging 6 2004Q2

      http://download.oracle.com/docs/cd/E19577-01/index.html

      Sun Java System Instant Messaging 6.1

      http://download.oracle.com/docs/cd/E19950-01/index.html

      Sun Java System Instant Messaging 7 2005Q1

      http://download.oracle.com/docs/cd/E19610-01/index.html

      Sun Java System Instant Messaging 7.0.1 2005Q4

      http://download.oracle.com/docs/cd/E19154-01/index.html

      Sun Java System Instant Messaging 7.2

      http://download.oracle.com/docs/cd/E19893-01/index.html

      Sun Java System Messaging Server 6 2004Q2

      http://download.oracle.com/docs/cd/E19522-01/index.html

      Sun Java System Messaging Server 6 2005Q1

      http://download.oracle.com/docs/cd/E19142-01/index.html

      Sun Java System Messaging Server 6 2005Q4

      http://download.oracle.com/docs/cd/E19796-01/index.html

      Sun Java System Messaging Server 6.0

      http://download.oracle.com/docs/cd/E19752-01/index.html

      Sun Java System Messaging Server 6.3

      http://download.oracle.com/docs/cd/E19563-01/index.html

      Sun ONE Calendar Server 5.1.1

      http://download.oracle.com/docs/cd/E19258-01/index.html

      Sun ONE Instant Messaging 6.0.1

      http://download.oracle.com/docs/cd/E19195-01/index.html

      Sun ONE Messaging Server 5.2

      http://download.oracle.com/docs/cd/E19444-01/index.html

      iPlanet Delegated Administrator 4.5

      iPlanet Messaging Server 5.0

      iPlanet Messaging Server 5.1

      Netscape Collabra Server

      Netscape Messaging Server 3.0

      Netscape Messaging Server 3.5

      Sun Internet Mail Server 3.5

      Sun Internet Mail Server 4.0

      Sun Java System Connector for Microsoft Outlook 6.0

      Sun ONE Synchronization 1.1

      http://download.oracle.com/docs/cd/E19957-01/index.html

      Japanese Translations

      iPlanet Messaging Server 5.2 Admin Guide JA

      iPlanet Messaging Server 5.2 Admin Reference JA

      Sun Java System Messaging Server 6.3 Admin Guide JA

      http://download.oracle.com/docs/cd/E19957-01/816-5017-01/

      http://download.oracle.com/docs/cd/E19957-01/816-6005-10/contents.htm

      http://download.oracle.com/docs/cd/E19299-01/820-0511/index.html

      Tuesday Mar 16, 2010

      Searching the Communications Suite Information, or You Can't Always Get What You Want

      I still hear all too often that while the Communications Suite wiki is chock full of information, it is sometimes hard to find things.

      My initial reaction is, have you read Finding What You Are Looking For? You just might get what you need.

      Wednesday Feb 03, 2010

      Communications Suite: Messaging Server Administration Guide Now All In on WSC

      In the midst of all the recent news about Oracle and Sun, I'd like to mention that the Messaging Server Administration Guide is now completely converted and ported to wikis.sun.com. We've created three ways to access this information:

      1. Alphabetically, by page name.
      2. Traditional book view, with the same chapter ordering that you are used to from docs.sun.com.
      3. Printable version, enabling you to generate a PDF version. (See below for instructions on generating a PDF version.)

      Going forward, please use this wiki version. The original document on docs.sun.com will no longer be updated. Note that these wiki versions also contain new product information since the introduction of Messaging Server 7, which the docs.sun.com version does not contain.

       To print a wiki guide in PDF format:

      1. Log in to the Communications Suite wiki and navigate to Printable Docs.
        If you have never logged in before, see How to Contribute to the Communications Suite Wiki.
      2. Select one of the printable guides in the list.
      3. Click Tools in the upper right corner of the page.
      4. Click Export to PDF.
      5. Choose to display or save the file.


      Wednesday Dec 16, 2009

      Communications Suite Documentation: You Can Still Have Your Books and Read Them Too

      Recently, as I've been converting the Messaging Server Administration Guide from the docs.sun.com version to the wikis.sun.com version, I found that it was easy to put together a "traditional" book view of the information, with a minimum of extra work. Basically, wikis.sun.com  enables you to link to "pages" of information in any number of ways. So creating--or in this case, recreating--the view of the information by "chapter" just entailed creating a new wiki page and links to the converted information.

      So, for those of you who are used to the way we ordered the information in the Messaging Server 6.3 Administration Guide, you'll probably find this view of the information on wikis.sun.com  very helpful.

       Note: I am still converting a few remaining chapters, which is why you'll see the small warning image next to a few chapter names.

      Reminder: Going forward, we are updating just the wikis version, so it's a good idea to start referencing it more and more often.


      Wednesday Sep 30, 2009

      Communications Suite Wiki: Seek and Ye Shall Find

      I wanted to address an issue that comes up from time to time with documentation for anything: how do you find what you are looking for? And do it quickly? The wikis.sun.com model provides a number of ways to get to information:

      • You can browse by page, label, and recent updates.
      • You can use the global search, for all wiki spaces, or the site-specific search, which we provide on every page of our Communications Suite wiki sites.
      • Yes, you can still google for information, but my recommendation is to use the wikis.sun.com specific ways of getting to the information. Indeed, I find the wikis.sun.com search to be quite fast and effective in finding what I'm looking for.
      I put together a summary of the various ways to find the information you are seeking. Give it a read: Finding What You Are Looking For

       I do realize that as a writer of this information, I'm at an advantage, knowing where everything is. It is my job to make it easy for the community to also know where everything is. So leave a comment if you have suggestions for how to improve our wiki docs model, especially if you are having difficulty locating particular information.

      Friday Aug 14, 2009

      Messaging Server 64-Bit Edition: The Better Choice

      Using Messaging Server 64-bit Edition

      Beginning with the release of Messaging Server 6.3, on Solaris OS, you have had the choice to install the 64-bit version of Messaging Server. The Communications Suite Product team now recommends that you install 64-bit Edition for new installations on Solaris OS, and upgrade your existing Solaris OS 32-bit Messaging Server deployments to the 64-bit version as time permits. You should no longer be installing the 32-bit version of Messaging Server on Solaris OS.

      Reasons to use or switch to Messaging Server 64-bit Edition include:

      Thursday Jun 25, 2009

      Communications Suite Wiki: Top Twenty Pages

      Have a look at the top twenty most frequently accessed pages on the Communications Suite wiki(s) for June. I see a noticeable uptick in access to Communications Suite 6 Update 2 information.

      Monday Jun 02, 2008

      CommSuite Wiki: How Did We Ever Manage Without It?

      What I'm finding exciting about using wikis.sun.com for the Communications Suite product documentation is that we can continually find new ways to enhance the information and try something out on-the-fly as part of the evolving grand experiment.

      Today I realized that we've been adding some important new pages to the wiki. And I began to wonder, how does one find out about these new pages? So I added a "What's New" panel to the CommSuite Wiki front page, alerting readers to pages have recently been added (as opposed to this list, which tracks recent changes to pages).

      I realize that at times it can be difficult to search for and find the exact information that you are looking for. I hope this "What's New" panel helps at least with alerting you to new pages as they get created.

      Thursday May 15, 2008

      Comms Suite Doc Wiki: The Whole Enchilada

      Someone was asking me today, "How do you find things on the Comms Doc Wiki?" A valid question, to be sure. I thought about it for a bit, and asked back, "What are you looking for." "Everything, the whole enchilada" came the reply. "I want to browse everything."

      Fortunately, wikis.sun.com (by way of the Confluence wiki engine) has an easy way to do this. For the Comms Suite Wiki, we made use of a macro to generate an index of all content, organized A-Z:

      CommSuite Doc Index, aka The Whole Enchilada

      Friday Feb 01, 2008

      To Wiki or Not To Wiki, Is That the Question?

      With little fanfare, we rolled out the Communications Suite documentation wiki this week. The wiki provides Communications Suite 6 (currently in Beta) product documentation and other technical information traditionally hosted on docs.sun.com. Anyone with a Sun Online Account (SOA) is able to leave comments and/or edit content on this wiki.

      I'll be the first to admit, this is a risky move on our part. Indeed, we should be wary about becoming too enthusiastic about using wikis to deliver non-open source product documentation. In many ways, such a move can be viewed as a step backward.

      Some of the negatives include:

      • Figuring out how to handle contributions from the outside (and the inside, for that matter)
      • Dealing w/ release-specific information (and creating snapshots) versus creating more 'living' documentation not tied to a release
      • Loss of formatting and other production options that traditional publication tools provide (indeed, just had to do a search and replace on our wiki, which is more of a manual hunt and replace)
      • No real printing to PDF solution (yet)
      • How to localize the content when it's a constantly moving target

      However, I'm ready to accept these negatives based on what's happened so far with the Comms Suite wiki. Yes, we've traded down in many areas, but in our ability to communicate with customers and respond to their needs, we've greatly traded up.

      Already, in just a few scant days, the response from our users has been very positive. Our users appreciate the ability to comment on the documentation and receive immediate responses in a way that is so unlike our previous model of no back-and-forth communication whatsoever. Also, as users are making suggestions for new pages, or asking questions, or wondering about the relation between topic areas, we as the wiki info managers (aka writers) are acting in real-time to better the information and prioritize our efforts.

      But I'd caution that this approach is not for everyone nor for all products. Indeed, I can't really see myself becoming an advocate (just yet, anyways); every product should look at its own needs to see if a wiki-based doc delivery has merit. Communications Suite is unique in a number of ways: we are a relatively small community, especially when compared to the hundreds of thousands of Java users out there. We have some passionate users who want to share their knowledge, and who have already been collaborating for years through email aliases. The wiki approach to product documentation seems like the next extension of this collaboration.

      It's been my experience, too, that the Comms community--like most these days--is interested overall in getting timely, accurate information, however and whatever the delivery mechanism. In the past, we in Pubs have been slow to meet this need, and our toolset hasn't always been a help. One can easily see the benefit in using a wiki to meeting customer expectation for fast and good information, even if at first blush, there may be some edges that need smoothing. Again, the open wiki model will does present some downside in potentially initially accepting somewhat imperfect content by a technical writer's standards. But I believe that not only can the content be improved over time and brought up to snuff, the timeliness and expert content coverage outweigh this situation.

      Stay tuned as we continue with this experiment.

      About

      Reporting about Unified Communications Suite Documentation, including news, Comms 101, documentation updates, and tips and tricks.

      Search

      Archives
      « April 2014
      SunMonTueWedThuFriSat
        
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
         
             
      Today