HyperFORGE Guidelines
Getting Started
Hyperic HQ is the enterprise monitoring product from Hyperic
. HQ's plugin architecture was designed to be extremely flexible, allowing for easy creation and deployment of new plugins. Because of this flexible plugin architecture, HQ is able to manage more technologies and more quickly than other monitoring systems. If you're new to Hyperic, see our products and about pages. If you're familiar with Hyperic and want to find out more about HQ management plugins, visit the Plugin Development Center. To learn about HQU plugins, see hquplugins.org.
This document explains how to use the HyperFORGE site and collaborate with other Hyperic community members. The purpose of the HyperFORGE is to facilitate collaboration on Hyperic HQ plugin development and HQ documentation.
Registration / Logging In
In order to annotate or add any documents and plugins, you must be logged in as a verified user on the Hyperic wiki. Use the following links:
HyperFORGE Navigation
Plugins and documents are arranged by category - plugins for database and application server software are found in their respective categories. For the contributed documentation, new categories will be created as more submissions arrive.
Other links found in the HyperFORGE direct the user to topics such as a comprehensive view of Hyperic HQ plugins, how to install new plugins, instructions on contributing to Hyperic, and Hyperic's official online documentation.
How Can You Contribute?
Annotation and Comments
We chose to build the HyperFORGE with the Confluence wiki in order to give users an easy way to add commentary to each page. For example, if deploying a specific plugin requires that a sysadmin perform a task not in the documentation, we hope that someone add a comment to that effect. The commentary on each page should provide users with a "missing manual" that fills in whatever gaps may be in the documentation. Also, if a user has created a small patch for a plugin, adding a comment is an easy way to document that for all to see.
To add a comment, you will see a link at the bottom of every page in the HyperFORGE.
Contributing New Plugins or Documentation
Being a wiki, adding or editing a plugin or documentation page is a breeze. Assuming you have registered successfully, you have permission to edit every page and add links to your content. If this is your first time using Confluence, please take some time to review the Confluence notation guide.
Editing any page is a matter of clicking the "Edit Page" link found in the left sidebar under "Page Operations".
If you would like to add a new page to the forge, simply click on the
Make sure to add your contribution to the Incoming Contribs page!
Adding Plugin or Doc Links to the Front Page
When adding a plugin, add it to the category that makes the most sense, although it might not be a perfect fit. Do not include version numbers in any links from the front page.
For new HOWTO's, name the new area or add to an existing area by the technology name first at its highest level. If a technology is not appropriate, then name it by its protocol. E.g., JasperSoft first, and JMX if not applicable to a specific technology. DO NOT include version numbers in the area name, however do include them in the HOWTO name or within the document.
Want to be an Official Contributor?
If you're not satisfied with merely putting your plugin, patch or documentation on the HyperFORGE, we also provide a way for contributions to become a part of the official HQ distribution. Make sure to read the Hyperic Contributor HOWTO. Official contributors are required to sign a contributor agreement.
Formatting
Required Information for Each Page
Be sure to include basic information on your area page for your contribution including:
- Authorship - who wrote it
- License terms
- Installation
- Configuration/Administration
- General Usage
As applicable include advanced information on your area page including:
- Security
- Integration considerations
- Internationalization (l10n, i18n)
- Troubleshooting: Performance, Usage
Writing Guidelines
In general, please use complete sentences and try not to use slang, as some readers may not be native English speakers. If you are doubtful about the spelling of a word, do not guess. Look up the correct spelling.(eg. www.dictionary.com). Proofread the copy that you submit and do correct minor typographical errors, formatting, spelling, or even the wording to ensure other readers will clearly understand you. Also make sure to check that technical steps are accurate, and where specific to an environment, the environmental variables are consistent and clear.
Avoid excessive use of personal pronouns such as I, me, and my, as he/she or him/her. Try to make the identifier role specific such as System Administrators, or IT Operators or Developers.
When abbreviating any terms, spell them out the first time. For instance, Service Oriented Architecture (SOA). Do not use too many abbreviations. Whereas one, two, or three can be helpful, four or five can be very confusing.
Do not purposely start a new page for discussion, as those should be carried on in the discussion forums.
Terms and Conditions of Use
Mutual Respect
Online communities rely on a system of mutual respect, or else the "community vibe" breaks down and forces the management, ie. me, to intervene. Please note that members who exhibit abusive, derogatory, condescending or otherwise negative behavior not conducive to community harmony can have their HyperFORGE accounts revoked. We will not tolerate community members who come here to bully others.
Intellectual Property Law
We do not condone the posting of content that violates copyright law. We request that you not post it. If others notify us of the existence of copyright-infringing material on this site, we will comply with the law.
Account Termination
We can terminate your account at any time, with or without stating the reasons for doing so.
Further Reading
Those interested in participating in the Hyperic HQ should look at the following documents:
- Code of Conduct - this document outlines the rules of engagement for all community members
- Hyperic Contributor HOWTO - read this if interested in contributing code to the supported Hyperic HQ distribution (does not apply to those who simply wish to contribute plugins or documentation to the HyperFORGE).
Help!
If you need assistance in anything, you can contact us at HyperFORGE at hyperic.com
