Documentation » Docs Wiki Collaboration
en

Docs Wiki Collaboration

NOTE: The documentation community group is no longer active on this website so information here may be out of date. Current Oracle Solaris 11 product documentation can be found here. Information about downloading Oracle Solaris 11 can be found here.

THIS PAGE IS UNDER DEVELOPMENT

Share Your Expertise!

The OpenSolaris Documentation Community wants to invite you to share your know-how about using OpenSolaris. We have provided a simple template for you to follow so you can plug in the interesting and useful info you know and share your expertise for the benefit of the larger OpenSolaris community. To get started, simply follow these steps:

  1. Decide if you want to add to the Tips and Tricks page or write a new "how to" procedure.
    • If adding to the Tips and Tricks, go here>>TBD.
    • If writing a new how to procedure, continue with step 2. 
  2. Look at the wish list for topics. If you have an idea or know of a documentation need, add to the wish list.
  3. Look at the dev list for topics already written or currently under development. If your topic is already under development,maybe you can collaborate on its completion. If it's not already  under development, pencil in your name and topic.
  4. Follow the instructions to copy the "how to" template and and start writing. (See Templates below.) 
  5. Label your page so that we can aggregate it onto a common TOC page.
     

Wish List

This is a page where users can list things they want documentation help with. See Wish List.

Dev List

TBD: A page that shows what folks are working on and status (so that don't have collisions with people duplicating effort).

Templates

We've created a template that provides basic and optional elements of a good how-to procedure. Use this basic structure of this template as the starting place for your procedure. Here are the steps to follow to use the template:

How to use the "How to Template"

  1. Log in to the documentation community site with your OpenSolaris user name and password.
  2. Navigate to the How To Template.
  3. Select Actions > Copy. (You must be logged in to see the Actions menu.)
    This displays the Copy Page page.
    • In the Target page field, enter the name of your new procedure.
      It is recommended you complete the following phrase and use it as the name the new page: How to <Do Something>. Replace <Do Something> with your task title.
    • Click Copy. The Copy Page page refreshes and should display an informational message that the template was copied to the new page name you specified. 
    • Click the link to the newly copied page.

KNOWN ISSUE

There appears to be a bug (bugzilla 12672) in copying the template. After copying, xwiki gives a confirmation message that the new page was copied:

Page Community Group documentation.How To Template  successfully copied to How To Do Something

The latter is a live link that resolves to http://hub.opensolaris.org/bin/view/Community+Group+documentation/How+To+Do+Something.

However, clicking that link redirects to the Notice page that says:

The requested document could not be found.
You can edit this page to create it.

WORKAROUND

After doing the copy, you should be able to find your newly copied page via this URL:

http://hub.opensolaris.org/bin/view/Community+Group+documentation/How+To+Template/<Your Page Name>

Labels

I need to prove to myself we can do this, but I'm hoping we can use labels and automate the collection of these page links on a single page. Would appreciate any inputs on this effort. I'll start assembling some of these pages as time allows.

Tags:
Created by alan mcclellan on 2009/11/10 18:05
Last modified by alan mcclellan on 2010/01/22 22:35

XWiki Enterprise 2.7.1.34853 - Documentation