Documentation Strategy
Subscribe

From OpenNMS

Jump to: navigation, search

Contents

Documentation Needs

We are in need of cleaning up our documentation for OpenNMS. The following outline are some areas where we want to concentrate on.

I. Getting Started
   A. Discovery (Ben) - 20% Complete
   B. Capsd (Ben)
      - Monitors

   C. Provisiond
      - Detectors (Ben)
      - Policies (Ben)

   D. Polling  (Ben)
      - Monitors

   E. Collectd (Jeff)
      - SNMP Collector
      - Other Collectors

   F. Notifications

   G. Trapd  (Alejandro)
      - varbinddecode
      - SNMPv3
      
   H. Syslogd (Alejandro)
      - Explain how to use it.

II. Migrating from old versions.
    - 100% Complete - http://www.opennms.org/wiki/Upgrade_Guide:_1.8_to_1.10

III. Multi system deployment

IV. Clean out and mark old documentation

Other Notes

Documentation should be written in a tutorial style. A getting started guide for on features.

Old outdated. WIKI mark items as outdated.

Add a version category.

Existing Documentation

This is a list of existing Documentation that may need to be reviewed or removed depending on its relevance.

Getting Started

QuickStart

Installation:Debian

Installation:URPMI

Discovery

Discovery

Capsd
Monitors

Monitors Category

Provisiond

Provisioning Adapters

Detectors
Policies
Polling

Polling_Configuration_How-To

Pollers

Monitors

Monitors Category

Service Pollers Category

Collectd

General Data Collection Information:

JDBC:

SNMP:

XML:

JMX:

HTTP:

WMI:

New Tutorials:

Notifications

Notification_Configuration_How-To

Trapd

Trapd

Creating_Threshold_Alarms

Thresholding

Syslogd
Other/Old

Tomcat_5.5_JMX_How-To

Tomcat_6_JMX_How-To