How To Participate

• How to Participate in OpenSolaris Documentation
  • Ramp Up
  • Provide Inputs
  • Ready to Write?
  • Existing Projects

How to Participate in OpenSolaris Documentation

The OpenSolaris documentation community is a group of writers and editors and community volunteers collaborating together to provide up-to-date technical information about using, managing, and developing on OpenSolaris.

Have an interest in writing, or do you have experience using OpenSolaris you could share with the rest of the community? Join the docs community. Here's how.

Ramp Up

There are several things you can do to get involved in the documentation community:

• Register for an OpenSolaris account: Sign up for an OpenSolaris account.
• Subscribe to the docs-discuss mailing list. Just click subscribe in the following link and send the empty email that pops up: Documentation community discussion forum.
• Bookmark the docs-discuss forum: Documentation discussion forum.
• Review the Style Guide for OpenSolaris: Documentation Style Guide for OpenSolaris.
• Familiarize yourself with OpenSolaris open-source licensing: OpenSolaris documentation licensing.

Provide Inputs

Open-source communities thrive based on the open exchange of information and ideas. This is critical to a vibrant docs community, so jump in and help improve the docs by commenting, helping clarify technical accuracy and readability, and filing bugs. Here's how you can help:

• File a doc bug or RFE: Reporting Bugs.
• Review or add topics to the documentation wish list. 

Ready to Write?

When you're ready to write, there are a few things you need to do. First, all contributors to OpenSolaris need to sign a Oracle Contributor Agreement (OCA). After you've done that, you'll need to determine what you want to work on and what format you want to work in. We have open-sourced docs in both wiki format (probably the easiest way to get started) and XML. (We provide Solbook 3.5 XML.) Use these resources to get going:

• Sign an OCA: Oracle Contributor Agreement
• Choose your authoring environment:
  • Author wiki-based docs. Share Your Expertise
  • Author XML-based docs.
    Open Sourced Documentation
    Documentation Tools 
    Doc download center 
    XML Templates 

Existing Projects

Documentation Projects Existing OpenSolaris documentation projects include the following:

• Wish List
• Multi-lingual Glossary
• Muskoka: An open repository for OpenSolaris technical content
• OpenSolaris Content Project
• SMF Documentation
• Starter Kit