aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Monitoring Plugins Development Team <devel@monitoring-plugins.org> 2014-01-18 03:40:24 -0500
committerGravatar Thomas Guyot-Sionnest <dermoth@aei.ca> 2014-01-19 14:18:47 -0500
commit63734f52ab1b4b2c17545b26fc41016d6bbd80bd (patch)
treedcd7aa3fd9a2a6a69a47d3a7e6a18d034426087a /doc
parent9db763963f3993f923619a2147e4313b09f12134 (diff)
downloadmonitoring-plugins-63734f52ab1b4b2c17545b26fc41016d6bbd80bd.tar.gz
Project rename initial commit.
This is an initial take at renaming the project to Monitoring Plugins. It's not expected to be fully complete, and it is expected to break things (The perl module for instance). More testing will be required before this goes mainline.
Diffstat (limited to 'doc')
-rw-r--r--doc/LEAVERS2
-rw-r--r--doc/NEW_STARTERS8
-rw-r--r--doc/RELEASING15
-rw-r--r--doc/developer-guidelines.sgml52
4 files changed, 37 insertions, 40 deletions
diff --git a/doc/LEAVERS b/doc/LEAVERS
index 65af3102..a52a6008 100644
--- a/doc/LEAVERS
+++ b/doc/LEAVERS
@@ -10,5 +10,5 @@ Administration tasks:
- Remove from GitHub's project members. This will include Git access.
- Remove access from project server
- If applicable, remove from mailing list administrators
- - Keep on nagiosplug-team mailing list, unless specifically requested to be removed
+ - Keep on team mailing list, unless specifically requested to be removed
diff --git a/doc/NEW_STARTERS b/doc/NEW_STARTERS
index ba194492..2c5aac88 100644
--- a/doc/NEW_STARTERS
+++ b/doc/NEW_STARTERS
@@ -4,12 +4,12 @@ These are the steps for adding someone to the team.
Need to know:
- Name
- - Primary email for nagiosplug-team mailings
+ - Primary email for team mailings
- GitHub account
- Type of member (translator, developer, release manager, project administrator)
-1. Add member to nagiosplug-team mailing list (https://lists.sourceforge.net/lists/admin/nagiosplug-team)
- and to the nagiosplug-checkins mailing list (https://lists.sourceforge.net/lists/admin/nagiosplug-checkins,
+1. Add member to team mailing list (https://www.monitoring-plugins.org/list/listinfo/team/)
+ and to the commits mailing list (https://www.monitoring-plugins.org/list/listinfo/commits/),
add sourceforge email address via Privacy Options->Sender filters)
2. Add Sourceforge access:
- Translator: CVS access, Shell access, Release Tech (no)
@@ -21,4 +21,4 @@ Need to know:
3. Create account on project server
- Add public ssh keys
4. Add Git access on repos.or.cz
-5. Send email to nagiosplug-team introducing new member
+5. Send email to team introducing new member
diff --git a/doc/RELEASING b/doc/RELEASING
index 34bed939..1eaec9de 100644
--- a/doc/RELEASING
+++ b/doc/RELEASING
@@ -1,8 +1,5 @@
NOTES ON RELEASING NEW VERSION OF NAGIOSPLUG
-NB: A copy of this document is located at:
- http://nagiosplugins.org/node/96
-
*** Pre-release
git pull
. tools/devmode, if feeling adventurous
@@ -24,15 +21,15 @@ git push origin master
git push origin release-1.4.14
*** Checkout new version
-rm -fr /tmp/nagioslug
+rm -fr /tmp/monitoringlug
# If you need to checkout the tag, don't forget to "checkout master" later to
# get back to your development branch:
git checkout tags/release-1.4.14
# Beware: the trailing slash of --prefix is REQUIRED
-git checkout-index --prefix=/tmp/nagioslug/ -a
+git checkout-index --prefix=/tmp/monitoringlug/ -a
*** Build the tarball
-cd /tmp/nagioslug
+cd /tmp/monitoringlug
tools/setup
./configure
make dist
@@ -43,7 +40,7 @@ SF username and password
cd /uploads
put file
-SF -> Submit News about release. Make sure it is called "Nagios Plugins" (with those caps)
+SF -> Submit News about release. Make sure it is called "Monitoring Plugins" (with those caps)
Link to download at http://sourceforge.net/project/showfiles.php?group_id=29880
Include contents of NEWS for this release
List all people on team involved.
@@ -60,5 +57,5 @@ Step 3: *.tar.gz, Platform Independent, Source .gz
Step 4: Send notice
*** Announce new release
-Send email to nagiosplug-help, nagios-announce with the news text
-Add a news item to http://nagiosplugins.org
+Send email to help, announce with the news text
+Add a news item to https://monitoring-plugins.org
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 666d7cc7..d9340285 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -1,18 +1,18 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" >
<book>
- <title>Nagios Plugin Development Guidelines</title>
+ <title>Monitoring Plugins Development Guidelines</title>
<bookinfo>
<authorgroup>
<author>
<affiliation>
- <orgname>Nagios Plugins Development Team</orgname>
+ <orgname>Monitoring Plugins Development Team</orgname>
</affiliation>
</author>
</authorgroup>
<pubdate>2013</pubdate>
- <title>Nagios Plugin Development Guidelines</title>
+ <title>Monitoring Plugins Development Guidelines</title>
<revhistory>
<revision>
@@ -23,7 +23,7 @@
<copyright>
<year>2000 - 2013</year>
- <holder>Nagios Plugins Development Team</holder>
+ <holder>Monitoring Plugins Development Team</holder>
</copyright>
</bookinfo>
@@ -34,8 +34,8 @@
the plugin developers and encourage the standarization of the
different kind of plugins: C, shell, perl, python, etc.</para>
- <para>Nagios Plugin Development Guidelines Copyright (C) 2000-2013
- (Nagios Plugins Team)</para>
+ <para>Monitoring Plugins Development Guidelines Copyright (C) 2000-2013
+ (Monitoring Plugins Team)</para>
<para>Permission is granted to make and distribute verbatim
copies of this manual provided the copyright notice and this
@@ -48,8 +48,8 @@
<article>
<section id="DevRequirements"><title>Development platform requirements</title>
<para>
- Nagios Plugins are developed to the GNU standard, so any OS which is supported by GNU
- should run the plugins. While the requirements for compiling the Nagios Plugins release
+ Monitoring Plugins are developed to the GNU standard, so any OS which is supported by GNU
+ should run the plugins. While the requirements for compiling the Monitoring Plugins release
are very basic, developing from the Git repository requires additional software to be
installed. These are the minimum levels of software required:
@@ -152,7 +152,7 @@
<section><title>Plugin Return Codes</title>
<para>The return codes below are based on the POSIX spec of returning
a positive value. Netsaint prior to v0.0.7 supported non-POSIX
- compliant return code of "-1" for unknown. Nagios supports POSIX return
+ compliant return code of "-1" for unknown. Nagios supports POSIX return
codes by default.</para>
<para>Note: Some plugins will on occasion print on STDOUT that an error
@@ -379,7 +379,7 @@
</listitem>
</orderedlist>
- <para>It is up to third party programs to convert the Nagios Plugins
+ <para>It is up to third party programs to convert the Monitoring Plugins
performance data into graphs.</para>
</section>
@@ -715,7 +715,7 @@ properly on non-FreeBSD systems. Install with 'CPPFLAGS="-UHAVE_LIBPTHREAD" ./co
</para>
<para>
-When you run Nagios Plugins' configure, it will look for the tap library and will automatically
+When you run Monitoring Plugins' configure, it will look for the tap library and will automatically
setup the tests. Run "make test" to run all the tests.
</para>
</section>
@@ -747,9 +747,9 @@ setup the tests. Run "make test" to run all the tests.
</section>
<section><title>Commit Messages</title>
- <para>If the change is due to a contribution, please quote the contributor's name
- and, if applicable, add the SourceForge Tracker number. Don't forget to
-update the THANKS.in file.</para>
+ <para>If the change is due to a contribution, please quote the contributor's name
+ and, if applicable, add the GitHub Issue Tracker number. Don't forget to
+ update the THANKS.in file.</para>
<para>If you have a change that is useful for noting in the next release, please
update the NEWS file.</para>
<para>All commits will be written to a ChangeLog at release time.
@@ -760,7 +760,7 @@ update the THANKS.in file.</para>
<para>To make the job easier for translators, please follow these guidelines:</para>
<orderedlist>
<listitem><para>
- Before creating new strings, check the po/nagios-plugins.pot file to
+ Before creating new strings, check the po/monitoring-plugins.pot file to
see if a similar string
already exists
</para></listitem>
@@ -790,15 +790,15 @@ update the THANKS.in file.</para>
version you are using. For new features, please supply a diff against
the Git "master" branch.</para>
- <para>Patches should be submitted via
- <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=397599">SourceForge's
- tracker system for Nagiosplug patches</ulink>
- and be announced to the nagiosplug-devel mailing list.</para>
+ <para>Patches should be submitted via
+ <ulink url="https://github.com/monitoring-plugins/monitoring-plugins/pulls">GitHub's
+ Pull requests for Monitoring Plugins</ulink>
+ </para>
<para>Submission of a patch implies that the submmitter acknowledges that they
are the author of the code (or have permission from the author to release the code)
- and agree that the code can be released under the GPL. The copyright for the changes will
- then revert to the Nagios Plugin Development Team - this is required so that any copyright
+ and agree that the code can be released under the GPL. The copyright for the changes will
+ then revert to the Monitoring Plugins Development Team - this is required so that any copyright
infringements can be investigated quickly without contacting a huge list of copyright holders.
Credit will always be given for any patches through a THANKS file in the distribution.</para>
</section>
@@ -806,22 +806,22 @@ update the THANKS.in file.</para>
<section id="Contributedplugins"><title>Contributed plugins</title>
<para>Plugins that have been contributed to the project and
- distributed with the Nagios Plugin files are held in the contrib/ directory and are not installed
+ distributed with the Monitoring Plugins files are held in the contrib/ directory and are not installed
by default. These plugins are not officially supported by the team.
The current policy is that these plugins should be owned and maintained by the original
- contributor, preferably hosted on <ulink url="http://exchange.nagios.org">Nagios Exchange</ulink>.
+ contributor, preferably hosted on <ulink url="http://monitoringexchange.org">Monitoring Exchange</ulink>.
</para>
<para>If patches or bugs are raised to an contributed plugin, we will start communications with the
original contributor, but seek to remove the plugin from our distribution.
</para>
- <para>The aim is to distribute only code that the Nagios Plugin team are responsible for.
+ <para>The aim is to distribute only code that the Monitoring Plugins team are responsible for.
</para>
</section>
<section id="Newplugins"><title>New plugins</title>
<para>If you would like others to use your plugins, please add it to
the official 3rd party plugin repository,
- <ulink url="http://exchange.nagios.org">Nagios Exchange</ulink>.
+ <ulink url="http://monitoringexchange.org">Monitoring Exchange</ulink>.
</para>
<para>We are not accepting requests for inclusion of plugins into
@@ -832,7 +832,7 @@ update the THANKS.in file.</para>
<orderedlist>
<listitem>
<para>Include copyright and license information in all files. Copyright must be solely
- granted to the Nagios Plugin Development Team</para>
+ granted to the Monitoring Plugins Development Team</para>
</listitem>
<listitem>
<para>The standard command options are supported (--help, --version,