diff --git a/README.md b/README.md index c1ea1be3533a22a1aac01f29983f6307f165a859..6003cb08fd8177cb67c80639b8633fe698f5a23d 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,47 @@ -# Centreon - IT and Application monitoring software # +# Centreon - IT and Application monitoring software # -## Introduction ## +## Introduction ## -Centreon is one of the most flexible and powerful monitoring softwares on the market; it is absolutely -free and Open Souce. +Centreon is one of the most flexible and powerful monitoring softwares +on the market; it is absolutely free and Open Souce (released under GNU +General Public License version 2, see LICENSE file). -This software requires an engine and a broker to be operational, refer to the documentation for more -information. +This software requires [Centreon Engine](https://github.com/centreon/centreon-engine) +and [Centreon Broker](https://github.com/centreon/centreon-broker) to be +operational. -## Docs ## +*Quick links* +* the official [Centreon (company) website](https://www.centreon.com) +* the official [online documentation](https://documentation.centreon.com) +* our [bugtracker](https://github.com/centreon/centreon/issues +* the [forum](http://forum.centreon.com) +* the [download center](https://download.centreon.com) -Find installation and user documentations at -[http://documentation.centreon.com](http://documentation.centreon.com). +## Download / Install ## -## About ## +The fastest way to install up-to-date software from Centreon is to use +our [Centreon Enterprise Server](https://www.centreon.com/en/products/centreon-enterprise-server/) +Linux distribution, which comes with our software already packaged. -### Authors ### +Latest source releases can be retrieved from [Centreon download center](https://download.centreon.com). +They can be installed by following the [online installation guide](https://documentation.centreon.com/docs/centreon/en/latest/installation/from_sources.html). -#### Project leaders #### +## Bug report / Feature request ## + +Bug reports and feature requests are more than welcome. However if you +wish to open a new issue, please read [this page](project/issues.md) +first. + +## Authors ## + +### Project leaders ### * Julien Mathis * Romain Le Merlus -#### Dev team #### +### Dev team ### * Lionel Assepo * Maximilien Bersoult +* Kevin Duret +* Toufik Mechouet +* Rabaa Ridene * Remi Werquin -* Sylvestre Ho - -### License ### - -Centreon is distributed under GNU GPL v2 license, see LICENSE. - -### Contacts ### - -You can report bugs or suggest features by using the -[issue tracker](https://github.com/centreon/centreon/issues). diff --git a/project/issue-workflow.png b/project/issue-workflow.png new file mode 100644 index 0000000000000000000000000000000000000000..102c0e35f2f0ede421bae3324d1b4f25492dab8e Binary files /dev/null and b/project/issue-workflow.png differ diff --git a/project/issues.md b/project/issues.md new file mode 100644 index 0000000000000000000000000000000000000000..8f22db2dec4b44e6e26b498f16c37c048dca994c --- /dev/null +++ b/project/issues.md @@ -0,0 +1,33 @@ +# Bug report / Feature request # + +If you wish to open a bug report or ask for a new feature, you are +reading the proper page ! We value your feedback very much. However to +keep things simple for you and for us, some basic rules must be set. + +## Issue workflow ## + +Here is the basic issue workflow for most Centreon software. Steps and +transitions are explained below. + + + +Step | Description +-----|------------ +Open | This is the default state when a new issue is open. It should be reviewed by a team member soon. +Need more information | The issue does not contain enough information to make something out of it. +In backlog | For a bug, it was confirmed. For a feature request it was granted. However it does not have enough priority to be scheduled for release yet. +Scheduled for release | Issue is scheduled for development and release. It will likely be implemented within the next month or so. +Implemented | Issue was developed. Code is available from the repository. +Closed | Either the issue was rejected or released. + +Transition | Steps | Description +-----------|-------|------------ +Question | Open -> Need more information | Issue does not contain enough information. The team member will ask for clarification. +Dont't want to implement / Duplicate | Open -> Closed | Some reason made us close this issue directly. The most common cases are duplication of an existing issue, we do not want to implement it or we cannot reproduce it. +Backlog refinement | Open -> In backlog | Features or bugs are added to the backlog if they are desirable. +Emergency | Open -> Scheduled for release | If an issue has very high priority (security hole, software crash, [Centreon support customer incident](https://www.centreon.com/en/technical-support-expertise/support/), ...) it is directly scheduled for development and release. +Reply | Need more information -> Open | The issue creator gave more information on the issue. It will be reviewed again. +No answer | Need more information -> Closed | Too much time elapsed since the team member asked for clarification. Issue will be closed to prevent it from polluting the list. +Sprint planning | In backlog -> Scheduled for release | The issue was added to the current sprint. It is likely to be implemented within the next month or so. +Story done | Scheduled for release -> Implemented | Issue was completed. Code, tests and documentation were committed to the repository. +Release | Implemented -> Closed | Issue is attached to a specific milestone that was released. It is available from binary and source packages.