How to Participate in Open HA Cluster Documentation
Open HA Cluster documentation will be introduced in phases, following as closely as possible the Open HA Cluster code it supports. Some aspects of contributing to Open HA Cluster documentation is handled through the documentation community or share that community's processes or tools.
In this initial stage of the Open HA Cluster collaboration, here is what you can do to participate in documentation of Open HA Cluster agents:
- Introduce yourself: Send us your ideas for instructions, guidelines, and doc collaboration by posting a message to the documentation:discuss discussion group.
- Send a URL for a requested or new document: Monitor the ha-clusters:discuss discussion forum and respond to requests for documentation.
- Send review feedback for a draft document: Reply to postings for cluster documentation review on the docs-discuss review page.
Licensing
See OpenSolaris Documentation Licenses for information about the licenses associated with contributions to open-source documentation. In particular, contributors are required to submit a Sun Contributor Agreement.
How to Work With a Documentation Sponsor
To request a sponsor for documentation contributions, send a request through the documentation:discuss discussion group. Alternatively, you can send an email from the email address you registered with to ha-clusters-discuss@opensolaris.org; your message will be posted to the documentation:discuss message board.
Sun documentation sponsors work with the community to support the documentation that is needed for features, projects, bug fixes, and enhancements that integrate into Open HA Cluster. We have identified experienced writers from the Sun Cluster writer community who have backgrounds in man pages, system administration documentation, and developer documentation. They will monitor the docs-discuss mail list for questions and requests for assistance.
Filing and Fixing a Documentation Bug
Filing and fixing a bug in the documentation is the same as filing and fixing a bug in the source code. The only difference is the categories under which you file a documentation bug, which are as follows:
- doc - All documents other than online help and man pages.
- manpages - All man pages, open sourced or not.
- online-help - All online help.
To learn more, see Fixing a Bug in the Software and in the Documentation.