cwjohnston / sensu-plugin-doc-draft

A short draft including two templates as intended standard for Sensu plugin documentation

suggestions

• Here's an example for the standard case (small to medium size plugin): sensu-plugins-standard-example
• Here's the example for large plugins (e.g. aws): sensu-plugins-large-example

current plugin doc situation

The following list has been put together manually according to this criteria:

• Is more than a list of files: This is the least helpful case (and I'll obviously not fill in the rest of the fields).
• Describes basic functionality: Has one or more meaningful sentences what the plugin does, apart from its name.
• Has a usage example.
• Installation instructions has more content than a link to the plugin site with general hints.
• There are no empty sections are in the Readme.

I have left the sensu-plugins- prefix out.

plugin name	more than files	basic functionality	usage example	install instructions	no empty sections
ansible	YES	NO	YES	NO	NO
apache	NO
aws	YES	NO	YES	YES	YES
beanstalk	NO
boundary	NO
campfire	YES	NO	YES	NO	NO
cassandra	NO
ceph	NO
chef	NO
consul	NO
couchbase	NO
cpu-checks	NO
cucumber	YES	YES	YES	NO	NO
datadog	YES	YES	YES	YES	NO
dhcp	NO
disk-checks	YES	YES	YES	NO	YES
dns	NO
docker	NO
elasticsearch	NO
erlang	NO
etcd	YES	NO	NO	NO	NO
eye	NO
filesystem-checks	NO
fluentd	YES	YES	YES	NO	NO
ftp	NO
github	YES	YES	NO	NO	NO
gluster	NO
gpg	NO
graphite	YES	NO	YES	NO	NO
graylog	NO
growthforecast	NO
haproxy	NO
hbase	NO
hipchat	YES	NO	YES	NO	NO
http	YES	NO	NO	NO	NO
icecast	NO
imap	NO
influxdb	YES	NO	YES	NO	NO
ipmi	NO
java	NO
jenkins	NO
kannel
logs	YES	NO	YES	NO	NO
lxc	NO
memcached	NO
memory-checks	YES	NO	YES	YES	NO
mesos	NO
mongodb	YES	NO	NO	NO	NO
monit	YES	YES	YES	NO	NO
mysql	YES	NO	YES	NO	NO
nzbget	NO
network-checks	YES	NO	YES	NO	NO
newrelic	NO
nginx	YES	YES	NO	NO	NO
officehours	NO
openldap	NO
openstack	NO
openvpn	YES	NO	YES	NO	NO
opsgenie	YES	NO	YES	NO	NO
pacemaker	NO
pagerduty	YES	NO	YES	NO	NO
percona	NO
php-fpm	YES	NO	YES	NO	NO
pingdom	NO
postfix	NO
postgres	NO
process-checks	YES	YES	NO	NO	NO
puma	NO
qmail	NO
rabbitmq	NO
raid-checks	NO
redis	NO
resque	NO
riak	YES	NO	YES	NO	NO
rspec	YES	NO	YES	NO	NO
selinux	NO
sensu	NO
serverspec	NO
sftp	NO
sip	NO
snmp	NO
solr	NO
springboot	NO
ssl	NO
supervisor	NO
syslog-ng	NO
telapi	NO
trafficserver	NO
tripwire	NO
twemproxy	YES	YES	YES	NO	NO
twilio	YES	NO	YES	NO	NO
uchiwa	NO
unicorn	NO
varnish	NO
windows	YES	YES	NO	NO	YES
youtube	NO

Notes

• The aws plugin is comparatively large and would not fit the same minimal standard for docs well. This is an edge case that has to be kept in mind, since other plugins could also grow larger.
• The monit readme needs to be completely rewritten to fit the style of other sensu plugin docs.
• Some plugins provide additional instructions that should be in "installation" in other sections.