]> granicus.if.org Git - icinga2/blobdiff - doc/1-about.md
Documentation: Refactor RemoteClient/Cluster/etc from community&training feedback
[icinga2] / doc / 1-about.md
index b8c7ee6b5d50689a31e41e751f22e98c4f812aa8..c64bc608b9a7b6945af945349bae356b3c7f8fc4 100644 (file)
@@ -1,42 +1,64 @@
-# About Icinga 2
+# <a id="about-icinga2"></a> About Icinga 2
 
-## What is Icinga 2?
+## <a id="what-is-icinga2"></a> What is Icinga 2?
 
-Icinga 2 is an enterprise-grade open source monitoring system which keeps watch over networks
-and any conceivable network resource, notifies the user of errors and recoveries and generates
-performance data for reporting. Scalable and extensible, Icinga 2 can monitor complex, large
-environments across dispersed locations.
+Icinga 2 is an open source monitoring system which checks the availability of
+your network resources, notifies users of outages, and generates performance
+data for reporting.
 
-## Licensing
+Scalable and extensible, Icinga 2 can monitor large, complex environments across
+multiple locations.
+
+## <a id="licensing"></a> Licensing
 
 Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
 General Public License Version 2, you will find a copy of this license in the
-LICENSE file included in the package.
+LICENSE file included in the source package.
 
-## Support
+## <a id="support"></a> Support
 
 Support for Icinga 2 is available in a number of ways. Please have a look at
-the support overview page at [https://support.icinga.org].
-
-## What's New in Version 0.0.3
-
-* `StatusDataWriter` and `ExternalCommandListener` (former `Compat`) and `CompatLogger`
-(former CompatLog) for status.dat/objects.cache/icinga2.cmd/icinga.log for Icinga 1.x Classic UI support
-* `IdoMysqlConnection` and `ExternalCommandListener` for Icinga 1.x Web
-* `IdoMysqlConnection` for Icinga 1.x Reporting, NagVis
-* `LivestatusListener` for addons using the livestatus interface (history tables tbd)
-* `PerfDataWriter` for graphing addons such as PNP/inGraph/graphite (can be loaded multiple times!)
-* `GraphiteWriter` for sending metrics to directly to graphite carbon sockets
-* `CheckResultReader` to collect Icinga 1.x slave checkresults (migrate your distributed setup step-by-step)
-* `ClusterListener` for real distributed architecture including config and runtime data (checks, comments, downtimes) sync and replay
-* `SyslogLogger`, `FileLogger` and `ConsoleLogger` for different types of logging
-* Domain support for distributed cluster environments
-* Config migration script supporting easier migration from Icinga 1.x configuration
-* Reviewed configuration options, additional attributes added
-* Enhanced ITL, added sample configuration
-* Enable/Disable Icinga 2 features on CLI
-* Documentation using Markdown (`Getting Started`, `Monitoring Basics`, `Object Types`, `Icinga Template Library`,
-`Advanced Topics`, `Migration from Icinga 1.x`, `Differences between Icinga 1.x and 2`, `Vagrant Demo VM`)
-* Vagrant Demo VM supported by Puppet modules installing RPM snapshots for Icinga 2, Icinga 1.x Classic UI and Web
-* Package snapshots available on [packages.icinga.org]
+the [support overview page](https://support.icinga.org).
+
+## <a id="contribute"></a> Contribute
+
+There are many ways to contribute to Icinga - whether it be sending patches,
+testing, reporting bugs, or reviewing and updating the documentation. Every
+contribution is appreciated!
+
+Please get in touch with the Icinga team at https://www.icinga.org/community/.
+
+### <a id="development"></a> Icinga 2 Development
+
+You can follow Icinga 2's development closely by checking
+out these resources:
+
+* [Development Bug Tracker](https://dev.icinga.org/projects/i2): [How to report a bug?](https://www.icinga.org/icinga/faq/)
+* Git Repositories: [main mirror on icinga.org](https://git.icinga.org/?p=icinga2.git;a=summary) [release mirror at github.com](https://github.com/Icinga/icinga2)
+* [Git Checkins Mailinglist](https://lists.icinga.org/mailman/listinfo/icinga-checkins)
+* [Development](https://lists.icinga.org/mailman/listinfo/icinga-devel) and [Users](https://lists.icinga.org/mailman/listinfo/icinga-users) Mailinglists
+* [#icinga-devel on irc.freenode.net](http://webchat.freenode.net/?channels=icinga-devel) including a Git Commit Bot
+
+For general support questions, please refer to the [community support channels](https://support.icinga.org).
+
+### <a id="how-to-report-bug-feature-requests"></a> How to Report a Bug or Feature Request
+
+More details in the [Icinga FAQ](https://www.icinga.org/icinga/faq/).
+
+* [Register](https://exchange.icinga.org/authentication/register) an Icinga account.
+* Create a new issue at the [Icinga 2 Development Tracker](https://dev.icinga.org/projects/i2).
+* When reporting a bug, please include the details described in the [Troubleshooting](16-troubleshooting.md#troubleshooting-information-required) chapter (version, configs, logs, etc).
+
+## <a id="whats-new"></a> What's new
+
+### What's New in Version 2.3
+
+#### Changes
+
+* [DB IDO schema upgrade](17-upgrading-icinga-2.md#upgrading-icinga-2) to `1.13.0` required!
+
+TODO
+
+#### Issues
 
+TODO