Add documentation (#7)

* add documentation * add tags to .xml * Update centreon.xml Co-authored-by: Alexandre Delaunay <[email protected]> --------- Co-authored-by: Mary-Clb <[email protected]> Co-authored-by: Alexandre Delaunay <[email protected]>
pluginsGLPI · Dec 14, 2023 · e051096 · e051096
1 parent 092ac94
commit e051096
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,41 @@
-# centreon GLPI plugin
+# Centreon GLPI plugin
 
-Add your plugin description here.
+This plugin allows you to see in your GLPI interface informations about the hosts that you are also monitoring in your Centreon app.
 
+## Set your configuration
+
+First, register your url to Centreon, username & password on the Centreon settings page :
+
+![centreon config page](https://github.com/pluginsGLPI/centreon/main/docs/screenshots/centreon-settings.jpg)
+
+As the connexion works successfully, a green badge appears on the bottom of the page.
+
+## See host status in your computers list
+
+You can now have a glimpse of your host status from the computers list :
+
+![centreon status on computer](https://github.com/pluginsGLPI/centreon/main/docs/screenshots/centreon-settings.jpg)
+
+## See all information about a host
+
+For seeing more, click on the host and on the Centreon tab : you can access to all general information about the host and its services, without going on your Centreon app !
+
+![centreon host page](https://github.com/pluginsGLPI/centreon/main/docs/screenshots/centreon-accueil.jpg)
+
+## Timeline and actions
+
+Click on the timeline tab to see what happened on your host recently : yesterday, since one week, or since one month :
+
+![centreon host page](https://github.com/pluginsGLPI/centreon/main/docs/screenshots/centreon-timeline.jpg)
+
+You can also perform 3 common actions :
+    1. Send a check
+    2. Set a downtime
+    3. Do an acknoledgement
+
+## Requirement
+
+To allow the plugin linking GLPI items with Centreon items, **they must have the same name** in both applications.
 ## Contributing
 
 * Open a ticket for each bug/feature so it can be discussed

diff --git a/centreon.xml b/centreon.xml
@@ -3,17 +3,21 @@
    <key>centreon</key>
    <!-- stable, beta, development, alpha, ... -->
    <state>stable</state>
-   <logo>https://raw.githubusercontent.com/pluginsGLPI/centreon/master/{LNAME}.png</logo>
+   <logo>https://raw.githubusercontent.com/pluginsGLPI/centreon/main/docs/logo1.png</logo>
    <description>
       <short>
          <!-- Add as many lang tag you want -->
-         <en>centreon GLPI plugin.</en>
-         <fr>Plugin GLPI centreon</fr>
+         <en>Centreon GLPI plugin.</en>
+         <fr>Plugin GLPI Centreon</fr>
       </short>
       <long>
          <!-- Add as many lang tag you want -->
-         <en>A long description for centreon GLPI plugin.</en>
-         <fr>Un description longue pour le plugin GLPI centreon</fr>
+         <en>This plugin allows displaying in the GLPI interface the general information of a machine that is also monitored in Centreon.
+         It is also possible to view the status of its services, its history, and to perform common actions such as checks, downtime, and acknowledgements.
+         </en>
+         <fr>Ce plugin permet d'afficher dans l'interface GLPI les informations générales d'une machine qui est également monitorée dans Centreon.
+         Il est également possible de consulter l'état de ses services, son historique et d'effectuer des actions courantes telles que les "checks", les "downtimes" et les "acknowledgements".
+         </fr>
       </long>
    </description>
    <homepage>https://github.com/pluginsGLPI/centreon</homepage>
@@ -27,11 +31,10 @@
    <versions>
       <!-- Add as many version tag you want -->
       <version>
-         <num>0.0.1</num>
+         <num>1.0.0</num>
          <!-- Add as many compatibility tag you want -->
-         <compatibility>9.4</compatibility>
-         <compatibility>9.3</compatibility>
-         <compatibility>9.2</compatibility>
+         <compatibility>~10.0</compatibility>
+         <download_url></download_url>
       </version>
    </versions>
    <langs>
@@ -40,18 +43,16 @@
       <lang>fr_FR</lang>
    </langs>
    <license>GPL V3+</license>
-   <!--tags>
+   <tags>
       <en>
-         <tag>One tag</tag>
-         <tag>Another tag</tag>
+         <tag>Centreon</tag>
+         <tag>Monitoring</tag>
+         <tag>Inventory</tag>
       </en>
-      <fr>
-         <tag>Un tag</tag>
-         <tag>Un autre tag</tag>
-      </fr>
-   </tags-->
-   <!--screenshots>
-      <screenshot>https://github.com/pluginsGLPI/fields/raw/master/screenshot.png</screenshot>
-      <screenshot>https://github.com/pluginsGLPI/fields/raw/master/screenshot2.png</screenshot>
-   </screenshots-->
+   </tags>
+   <screenshots>
+      <screenshot>https://github.com/pluginsGLPI/centreon/main/docs/screenshots/centreon-accueil.jpg</screenshot>
+      <screenshot>https://github.com/pluginsGLPI/centreon/main/docs/screenshots/centreon-settings.jpg</screenshot>
+      <screenshot>https://github.com/pluginsGLPI/centreon/main/docs/screenshots/centreon-timeline.jpg</screenshot>
+   </screenshots>
 </root>
diff --git a/docs/logo.png b/docs/logo.png
diff --git a/docs/logo1.jpeg b/docs/logo1.jpeg
diff --git a/docs/screenshots/centreon-accueil.jpg b/docs/screenshots/centreon-accueil.jpg
diff --git a/docs/screenshots/centreon-computers.jpg b/docs/screenshots/centreon-computers.jpg
diff --git a/docs/screenshots/centreon-settings.jpg b/docs/screenshots/centreon-settings.jpg
diff --git a/docs/screenshots/centreon-timeline.jpg b/docs/screenshots/centreon-timeline.jpg
diff --git a/setup.php b/setup.php
@@ -28,7 +28,7 @@
  * -------------------------------------------------------------------------
  */
 
-define('PLUGIN_CENTREON_VERSION', '0.0.1');
+define('PLUGIN_CENTREON_VERSION', '1.0.0');
 
 // Minimal GLPI version, inclusive
 define("PLUGIN_CENTREON_MIN_GLPI_VERSION", "10.0.0");