From 0f0a943d5429cf8db0f7f6cc9bc2679ed9329901 Mon Sep 17 00:00:00 2001 From: Holger Weiss Date: Tue, 14 Jan 2014 22:58:44 +0100 Subject: Rename Nagios Plugins to Monitoring Plugins This is a first step of replacing the name "Nagios Plugins" with "Monitoring Plugins" where appriopriate. Some news items and FAQ entries are also created or updated. More to come. --- web/input/doc/faq/compilation.md | 6 ++-- web/input/doc/faq/contribute.md | 2 +- web/input/doc/faq/control.md | 12 +++---- web/input/doc/faq/donations.md | 10 +++--- web/input/doc/faq/fork.md | 62 ++++++++++++++++++++++++++++++++++++ web/input/doc/faq/git.md | 12 +++---- web/input/doc/faq/gnulib.md | 4 +-- web/input/doc/faq/index.md | 8 +++-- web/input/doc/faq/installation.md | 2 +- web/input/doc/faq/libtap.md | 7 ++-- web/input/doc/faq/license.md | 8 ++--- web/input/doc/faq/packages.md | 4 +-- web/input/doc/faq/private-c-api.md | 8 ++--- web/input/doc/faq/reuse.md | 12 +++---- web/input/doc/faq/use-perl-module.md | 4 +-- 15 files changed, 110 insertions(+), 51 deletions(-) create mode 100644 web/input/doc/faq/fork.md (limited to 'web/input/doc/faq') diff --git a/web/input/doc/faq/compilation.md b/web/input/doc/faq/compilation.md index ac5fff7..45df8a2 100644 --- a/web/input/doc/faq/compilation.md +++ b/web/input/doc/faq/compilation.md @@ -1,4 +1,4 @@ -title: Building Nagios Plugins +title: Building Monitoring Plugins parent: FAQ --- @@ -6,8 +6,8 @@ parent: FAQ To compile version `1.x` of the plugins, you run: - $ gzip -dc nagios-plugins-1.x.tar.gz | tar -xf - - $ cd nagios-plugins-1.x + $ gzip -dc monitoring-plugins-1.x.tar.gz | tar -xf - + $ cd monitoring-plugins-1.x $ ./configure $ make diff --git a/web/input/doc/faq/contribute.md b/web/input/doc/faq/contribute.md index fe97a80..c92594f 100644 --- a/web/input/doc/faq/contribute.md +++ b/web/input/doc/faq/contribute.md @@ -16,7 +16,7 @@ you have full rights to it. If your pull request is accepted, we will (of course) retain the Git author name and email address, and we'll add your name to the list of contributors in the [THANKS][thanks] file. -[repo]: https://github.com/nagios-plugins/repositories "Our Repositories" +[repo]: https://github.com/monitoring-plugins/repositories "Our Repositories" [fork]: https://help.github.com/articles/fork-a-repo "Fork Documentation" [pull]: https://help.github.com/articles/using-pull-requests "Pull Request Documentation" [github]: https://github.com/ "GitHub" diff --git a/web/input/doc/faq/control.md b/web/input/doc/faq/control.md index 37a811f..59636a0 100644 --- a/web/input/doc/faq/control.md +++ b/web/input/doc/faq/control.md @@ -2,15 +2,11 @@ title: Who controls the project? parent: FAQ --- -# Who controls the Nagios Plugins project? +# Who controls the project? -[Nagios Enterprises][enterprises] own the Nagios Plugins project, hence the -domain names of the site belong to Nagios Enterprises. However, the [Nagios -Plugins Development Team][team] are responsible for the running of the -project. This means that decisions about the web site and the development of -code related to the project are handled independently by the team. +The Monitoring Plugins are maintained by an independent [team][team] of +volunteers. -[enterprises]: http://www.nagios.com/about/company "Nagios Enterprises" -[team]: team.html "Nagios Plugins Development Team" +[team]: team.html "Monitoring Plugins Development Team" diff --git a/web/input/doc/faq/donations.md b/web/input/doc/faq/donations.md index b7413e9..bc15968 100644 --- a/web/input/doc/faq/donations.md +++ b/web/input/doc/faq/donations.md @@ -4,16 +4,16 @@ parent: FAQ # Do you accept donations? -The [Nagios Plugins Development Team][team] accepts donations for the project. -We have a separate Paypal account that is used for donations, which is -administered by the team leader. +The [Monitoring Plugins Development Team][team] accepts donations for the +project. We have a separate Paypal account that is used for donations, which +is administered by the team leader. Donations go towards paying for the small administrative charges we have. We might also use some of the funds for team beer when we meet up in person. -Please contact if you're considering a +Please contact if you're considering a donation. -[team]: team.html "Nagios Plugins Development Team" +[team]: team.html "Monitoring Plugins Development Team" diff --git a/web/input/doc/faq/fork.md b/web/input/doc/faq/fork.md new file mode 100644 index 0000000..5057b80 --- /dev/null +++ b/web/input/doc/faq/fork.md @@ -0,0 +1,62 @@ +title: Did you fork? +parent: FAQ +--- + +# Did you fork the Nagios Plugins? + +TL;DR: No. They forked us. + +Long answer: + +Initially, there was a Nagios Plugins project. Today, there is both a [Nagios +Plugins][nagios-plugins] project and a [Monitoring Plugins][monitoring-plugins] +project. The answer to the question of who forked whom probably isn't +immediately obvious, especially for those who weren't involved in the mess. +It'll depend on how exactly you define a "fork", and it may not be all that +important anyway. + +However, because you asked, here's our view on the happenings. + +Originally, there was a Nagios Plugins project that was maintained by us; +i.e., a [team][team] of volunteers not affiliated with [Nagios +Enterprises][enterprises]. In 2011, we transferred the `nagios-plugins.org` +domain to Nagios Enterprises on their request. This transfer was coupled with +an [agreement][agreement] that we would continue to run the project +independently. Early in 2014, Nagios Enterprises copied most of our web site +and changed the DNS records to point to their web space instead, which then +served a slightly modified version of our site including the tarballs we +created. This was done without prior notice. Presumably, their +[reasoning][reasoning] for this move was that they weren't happy with us +[mentioning Icinga and Shinken][mentioning] on our home page. + +So, today there are two projects: + +One driven by the team that lost its domain, but that did the actual +maintenance work in the past, and that continues to maintain the same project +with the same infrastructure (e.g., the GitHub [repositories][repositories] +and [trackers][trackers], the [mailing lists][support], and the [automated +test builds][tests]) under the new name. + +The other project is driven by the company that controls the domain. + +So, if you ask us (as you did by definition when reading this): They clearly +forked us, not vice versa. We just see two differences to a "typical" fork +which makes this case less obvious: + +1. The project that has been forked didn't own its domain name. +2. The project that performed the fork did so without showing any previous + development activities. + +[nagios-plugins]: http://www.nagios-plugins.org/ "Nagios Plugins" +[monitoring-plugins]: index.html "Monitoring Plugins" +[team]: team.html "Monitoring Plugins Development Team" +[enterprises]: http://www.nagios.com/about/company "Nagios Enterprises" +[agreement]: news/domain-transfer.html "Domain Transfer Agreement" +[reasoning]: archive/devel/2014-January/009420.html "Reasoning of Nagios Enterprises" +[mentioning]: archive/devel/2014-January/009428.html "Response to Nagios Enterprises" +[repositories]: https://github.com/monitoring-plugins/repositories "GitHub Repositories" +[trackers]: https://github.com/monitoring-plugins/monitoring-plugins/issues "GitHub Issue Tracker" +[support]: support.html#mailing-lists "Mailing Lists" +[tests]: tests.html "Test Results" + + diff --git a/web/input/doc/faq/git.md b/web/input/doc/faq/git.md index 390b87a..e9bc27d 100644 --- a/web/input/doc/faq/git.md +++ b/web/input/doc/faq/git.md @@ -4,9 +4,8 @@ parent: FAQ # How do I use Git? -After the 1.4.13 release, the [Nagios Plugins Development Team][team] moved to -[Git][git] for its code repositories. This document is a quick introduction -to Git. +After the 1.4.13 release, the project moved to [Git][git] for its code +repositories. This document is a quick introduction to Git. ## Basic Concepts @@ -41,14 +40,14 @@ with Git you only have to type a handful of digits to reference one. To work on a project you first have to clone it. This creates your own local repository, and until you want to distribute your change or merge changes from someone else, everything that follows can happen offline. If you have push -access to the Nagios Plugins repository, run the command: +access to the Monitoring Plugins repository, run the command: - $ git clone git@github.com:nagios-plugins/nagios-plugins.git + $ git clone git@github.com:monitoring-plugins/monitoring-plugins.git If you just want a local copy or wish to clone it to your workstation, you can run this command instead: - $ git clone git://github.com/nagios-plugins/nagios-plugins.git + $ git clone git://github.com/monitoring-plugins/monitoring-plugins.git This will create a directory called `nagios-plugins` with all the `master` code and history (this is roughly equivalent to CVS/SVN `HEAD`). Change @@ -192,7 +191,6 @@ on the [Git web site][git]). - Git for Computer Scientists -[team]: team.html "Nagios Plugins Development Team" [guidelines]: doc/guidelines.html "Nagios Plugin Development Guidelines" [git]: http://git-scm.com/ "Git" [scott]: http://scottchacon.com/ "Scott Chacon" diff --git a/web/input/doc/faq/gnulib.md b/web/input/doc/faq/gnulib.md index 5b7299b..964940c 100644 --- a/web/input/doc/faq/gnulib.md +++ b/web/input/doc/faq/gnulib.md @@ -12,8 +12,8 @@ latest Gnulib code, do something like: $ cd gnulib $ GNULIB_HEAD=$(git rev-parse --short HEAD) $ cd .. - $ git clone git@github.com:nagios-plugins/nagios-plugins.git - $ cd nagios-plugins + $ git clone git@github.com:monitoring-plugins/monitoring-plugins.git + $ cd monitoring-plugins $ ../gnulib/gnulib-tool --update $ find gl -name '*~' -o -name '.gitignore' | xargs rm $ git status diff --git a/web/input/doc/faq/index.md b/web/input/doc/faq/index.md index 722362c..6b01670 100644 --- a/web/input/doc/faq/index.md +++ b/web/input/doc/faq/index.md @@ -4,12 +4,13 @@ parent: Documentation # FAQ -This is a list of Frequently Asked Questions (FAQ) regarding the Nagios +This is a list of Frequently Asked Questions (FAQ) regarding the Monitoring Plugins. ## General -* [Who controls the Nagios Plugins project?][control] +* [Who controls the project?][control] +* [Did you fork the Nagios Plugins?][fork] * [What license is the code distributed under?][license] * [Can I submit a patch?][contribute] * [Do you accept donations?][donations] @@ -41,9 +42,10 @@ Plugins. * [How do I use and update Gnulib?][gnulib] * [How do I use the Nagios::Plugin module?][use-perl-module] * [How do I modify NagiosMIB?][nagiosmib] -* [Can I use Nagios Plugins in my project?][reuse] +* [Can I reuse Monitoring Plugins code?][reuse] [control]: doc/faq/control.html +[fork]: doc/faq/fork.html [license]: doc/faq/license.html [contribute]: doc/faq/contribute.html [donations]: doc/faq/donations.html diff --git a/web/input/doc/faq/installation.md b/web/input/doc/faq/installation.md index 6f3694a..f13a9f9 100644 --- a/web/input/doc/faq/installation.md +++ b/web/input/doc/faq/installation.md @@ -1,4 +1,4 @@ -title: Installing Nagios Plugins +title: Installing Monitoring Plugins parent: FAQ --- diff --git a/web/input/doc/faq/libtap.md b/web/input/doc/faq/libtap.md index c592030..4bd115f 100644 --- a/web/input/doc/faq/libtap.md +++ b/web/input/doc/faq/libtap.md @@ -15,10 +15,11 @@ thread implementation. To workaround, run: $ make check $ make install -Now when you run the Nagios Plugins `./configure` script, it should find the -libtap library and compile the tests and run them when you run `make` `test`. +Now when you run the Monitoring Plugins `./configure` script, it should find +the libtap library and compile the tests and run them when you run `make` +`test`. -*Update:* These days, the Nagios Plugins tarball includes a copy of libtap +*Update:* These days, the Monitoring Plugins tarball includes a copy of libtap which is used if you run `./configure` `--enable-libtap`. [libtap]: http://jc.ngo.org.uk/trac-bin/trac.cgi/wiki/LibTap "libtap" diff --git a/web/input/doc/faq/license.md b/web/input/doc/faq/license.md index d4a369c..0818b3e 100644 --- a/web/input/doc/faq/license.md +++ b/web/input/doc/faq/license.md @@ -4,14 +4,14 @@ parent: FAQ # What license is the code distributed under? -The Nagios Plugins code is currently distributed using the [GNU General Public -License, Version 3][gpl] (GPLv3). +The Monitoring Plugins code is currently distributed using the [GNU General +Public License, Version 3][gpl] (GPLv3). This is because some C code that we depend upon, from the [Gnulib][gnulib] project, is distributed under the GPLv3; and therefore, some of our plugins also need to be GPLv3 licensed. The team has decided, rather than having a -mixed license, we'll distribute all of the core Nagios Plugins code under the -GPLv3. +mixed license, we'll distribute all of the core Monitoring Plugins code under +the GPLv3. [gpl]: http://www.gnu.org/licenses/gpl.html "GPLv3" [gnulib]: http://www.gnu.org/software/gnulib/ "Gnulib" diff --git a/web/input/doc/faq/packages.md b/web/input/doc/faq/packages.md index 2329db9..d3c1643 100644 --- a/web/input/doc/faq/packages.md +++ b/web/input/doc/faq/packages.md @@ -9,8 +9,8 @@ Short answer: **Yes**! Slightly longer answer: Most Linux distributions and BSD projects provide binary packages of the -Nagios Plugins. These are usually well-integrated and much easier to deploy -and maintain, so we strongly recommend using them whenever possible. +Monitoring Plugins. These are usually well-integrated and much easier to +deploy and maintain, so we strongly recommend using them whenever possible. Our source tarballs and the associated documentation are primarily intended for package maintainers, for those users who'd like to test them, and for the diff --git a/web/input/doc/faq/private-c-api.md b/web/input/doc/faq/private-c-api.md index c814d8c..700fd20 100644 --- a/web/input/doc/faq/private-c-api.md +++ b/web/input/doc/faq/private-c-api.md @@ -4,8 +4,8 @@ parent: FAQ # Private C APIs -This page describes the Nagios Plugins routines that can be accessed from the -internal library. +This page describes the Monitoring Plugins routines that can be accessed from +the internal library. This page is in development, so these are not guaranteed to be available. As the API matures and is available in libraries, this information will be @@ -15,8 +15,8 @@ migrated to the [Development Guidelines][guidelines]. ### np\_init(char \*plugin\_name, int argc, char \*\*argv) -Initialize the Nagios Plugins routines. Pass the plugin name and `argc` and -`argv` from `main()`. +Initialize the Monitoring Plugins routines. Pass the plugin name and `argc` +and `argv` from `main()`. A variable `nagios_plugin` will be created for internal use. diff --git a/web/input/doc/faq/reuse.md b/web/input/doc/faq/reuse.md index 6c8e7b0..f7fe8a6 100644 --- a/web/input/doc/faq/reuse.md +++ b/web/input/doc/faq/reuse.md @@ -2,21 +2,21 @@ title: Code reuse parent: FAQ --- -# Can I use Nagios Plugins in my project? +# Can I reuse Monitoring Plugins code? Firstly, there is a distinction between a Nagios plugin and plugins from the -Nagios Plugins project. +Monitoring Plugins project. Although Nagios (the system) is licensed under the GPL, plugins are executed in their own environment, so they [do not fall][aggregation] under the "viral" aspect of the GPL. Therefore, any plugin written for use by Nagios can be under any license the copyright holder selects. -However, the plugins contained within the Nagios Plugins project are +However, the plugins contained within the Monitoring Plugins project are distributed under the [GPL][gpl]. If you distribute an application that -includes the Nagios Plugins (modified or not), you are required to distribute -a copy of the source code for the plugins under the terms of the GPL, -regardless of the licensing for the rest of the application. +includes the Monitoring Plugins (modified or not), you are required to +distribute a copy of the source code for the plugins under the terms of the +GPL, regardless of the licensing for the rest of the application. If you write a plugin which is a derivative work from code of the Nagios Plugins project, then your plugin must also be licensed under the GPL, diff --git a/web/input/doc/faq/use-perl-module.md b/web/input/doc/faq/use-perl-module.md index 64ba18a..d624e5f 100644 --- a/web/input/doc/faq/use-perl-module.md +++ b/web/input/doc/faq/use-perl-module.md @@ -6,11 +6,11 @@ parent: FAQ The Nagios::Plugin Perl module can be obtained from two main locations: -* from the Nagios Plugins tarball with an +* from the Monitoring Plugins tarball with an [extra configure option][configure-module] * from [CPAN][cpan-module] -If you install from the Nagios Plugins tarball, the Perl module will be +If you install from the Monitoring Plugins tarball, the Perl module will be installed in `$prefix/perl`. If you install from CPAN, the Perl module will be installed into your Perl's -- cgit v1.2.3-74-g34f1