doc: move history and contrib to dedicated...

...pages

README.md

@@ -11,63 +11,16 @@ components on a single screen? That's what this module has been designed for!
 
 You're running a huge cloud, want to get rid of the monitoring noise triggered
 by your auto-scaling platform but still want to have detailed information just
-a couple of clicks away in case you need them? You will love this little addon!
+a couple of clicks away in case you need them? You will love this little module!
 
-Installation
+You got me! Where should I start from?
-============
+--------------------------------------
 
-Like with any other Icinga Web 2 module just drop me to one of your module
+Please start with our [installation instructions](doc/01-Installation.md), head
-folders and enable the `businessprocess` module in your web frontend or on CLI.
+on to our [getting started](doc/02-Getting-Started.md) introductions and learn
+how to create your first [business process definitions](doc/03-Create-your-first-process-node.md).
 
-Of course the `monitoring` module needs to be enabled and that's it, we have no
+You might also want to learn more about some interesting [web components](doc/12-Web-Components-Breadcrumb.md),
-further dependencies.
+this projects [history](doc/81-History.md) or how to [contribute](doc/84-Contributing.md).
-
-History
-=======
-
-The Business Process module is based on the ideas of the
-Nagios(tm) Business Process Addon written by Bernd Strößenreuther and available
-at http://bp-addon.monitoringexchange.org/. We always loved it's simplicity
-and while it looks pretty oldschool right now there are still many shops
-happily using it in production.
-
-Contributing
-------------
-
-The Businessprocess module is an Open Source project and lives from your contributions.
-No matter whether these are feature requests, issues, translations, documentation or
-code.
-
-* Please check whether a related issue alredy exists on our [Issue Tracker](https://github.com/icinga/icingaweb2-module-businessprocess/issues)
-* Make sure your code conforms to the [PSR-2: Coding Style Guide](http://www.php-fig.org/psr/psr-2/)
-* [Unit-Tests]( Current ) would be great
-* Send a [Pull Request](https://github.com/Icinga/icingaweb2-module-businessprocess/pulls)
- (it will automatically be tested on Travis-CI, PSR-2 is enforced)
-* We try hard to keep our master always green: [![Build Status](https://travis-ci.org/Icinga/icingaweb2-module-businessprocess.svg?branch=master)](https://travis-ci.org/Icinga/icingaweb2-module-businessprocess)
-
-Compatibiliy
-------------
-
-The Business Process module is tested on PHP versions 5.3 up to 7.1 (including
-nightly builds):
 
 [![Build Status](https://travis-ci.org/Icinga/icingaweb2-module-businessprocess.svg?branch=master)](https://travis-ci.org/Icinga/icingaweb2-module-businessprocess)
-
-We fully support the BPaddon config language and will continue to do so. It's
-also perfectly valid to run both products in parallel based on the very same
-config files.
-
-However, lot's of changes went on and are still going on under the hood. We
-have more features and new language constructs. We separated the config reader
-from the state fetcher in our code base. This will allow us to optionally
-support config backends like SQL databases. They are not faster than plain old
-text files, but they make it much easier to distribute configuration in a large
-environment.
-
-Improvements
-------------
-
-### Speed
-
-This module is definitively faster than the BPaddon used to be. No need for IDO
-caching or similar.

doc/01-Installation.md

@@ -7,6 +7,8 @@ Requirements
 * Icinga Web 2 (>= 2.4.1)
 * PHP (>= 5.3 or 7.x)
 
+The Icinga Web 2 `monitoring` module needs to be configured and enabled.
+
 Installation from .tar.gz
 -------------------------
 

doc/81-History.md

@@ -0,0 +1,46 @@
+History
+=======
+
+The Business Process module is based on the ideas of the Nagios(tm) [Business
+Process AddOn](http://bp-addon.monitoringexchange.org/) written by Bernd
+Strößenreuther. We always loved it's simplicity, and while it looks pretty
+oldschool right now there are still many shops happily using it in production.
+
+![BpAddOn Overview](screenshot/81_history/8101_bpaddon-overview.png)
+
+Compatibility
+-------------
+
+We fully support the BPaddon configuration language and will continue to do so.
+It's also perfectly valid to run both products in parallel based on the very same
+config files. New features are (mostly) added in a compatible way.
+
+Configuration titles and descriptions, properties related to state types or
+permissions are examples for new features that didn't formerly exist. They are
+stored as commented metadata in the file header and therefore invisible to the
+old AddOn.
+
+The only way to break compatibility is to use newly introduced operators like
+`ǸOT`. Once you do so, the old AddOn will no longer be able to parse your
+configuration.
+
+![BpAddOn Details](screenshot/81_history/8102_bpaddon-detail.png)
+
+Lot's of changes went on and are still going on under the hood. We have more
+features and new language constructs. We separated the config reader from the
+state fetcher in our code base. This will allow us to eventually support config
+backends like SQL databases or the Icinga 2 DSL.
+
+This would make it easier to distribute configuration in large environments.
+
+Improvements
+------------
+
+Major focus has been put on execution speed. So while the Web integration shows
+much more details at once and is able to display huge unfolded trees, it should
+still render and refresh faster. Same goes for the Check Plugin.
+
+Behaviour for all operators is now strictly specified and Unit-tested. You still
+can manually edit your configuration files. But much better, you also delegate
+this to your co-workers, as Business Process definitions can now be built directly
+in the GUI.

doc/84-Contributing.md

@@ -0,0 +1,19 @@
+Contributing
+============
+
+The Businessprocess module is an Open Source project and lives from your contributions.
+No matter whether these are feature requests, issues, translations, documentation or
+code.
+
+* Please check whether a related issue alredy exists on our [Issue Tracker](https://github.com/icinga/icingaweb2-module-businessprocess/issues)
+* Make sure your code conforms to the [PSR-2: Coding Style Guide](http://www.php-fig.org/psr/psr-2/)
+* [Unit-Tests]( Current ) would be great
+* Send a [Pull Request](https://github.com/Icinga/icingaweb2-module-businessprocess/pulls)
+ (it will automatically be tested on Travis-CI, PSR-2 is enforced)
+* We try hard to keep our master always green: [![Build Status](https://travis-ci.org/Icinga/icingaweb2-module-businessprocess.svg?branch=master)](https://travis-ci.org/Icinga/icingaweb2-module-businessprocess)
+
+Compatibiliy
+------------
+
+The Business Process module is tested on PHP versions 5.3 up to 7.1 (including
+nightly builds).