Auto-update README

README.md

@@ -1,27 +1,31 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Grafana for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/grafana.svg)](https://dash.yunohost.org/appci/app/grafana) ![](https://ci-apps.yunohost.org/ci/badges/grafana.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grafana.maintain.svg)  
-[![Install grafana with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grafana)
+[![Install Grafana with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grafana)
 
-> *This package allows you to install grafana quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+
+> *This package allows you to install Grafana quickly and simply on a YunoHost server.
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
-**Important: This package is designed to be fed by the NetData application for monitoring measures, so please make sure the YunoHost [NetData package](https://github.com/YunoHost-Apps/netdata_ynh/) is installed before installing it!**
 
-NetData only collects, displays and sets alarms based on data from the last hour; this packages allows to archive every metrics and put up statistics and dashboards on the long term.
+Metric & analytic dashboards for monitoring
 
-Note: You can use it without NetData, but you'll have to install a collection application (e.g. collectd) to gather data.
+**Shipped version:** 8.0.6~ynh1
 
-**Shipped version:** 7.5.5
+**Demo:** https://play.grafana.org
 
 ## Screenshots
 
-![](https://grafana.com/api/dashboards/1295/images/838/image)
+![](./doc/screenshots/Grafana8_Kubernetes.jpg)
 
-## Demo
+## Disclaimers / important information
-
-* [Official demo](https://play.grafana.org)
 
 ## Configuration
 
@@ -54,11 +58,6 @@ Note: You can use it without NetData, but you'll have to install a collection ap
 
 LDAP and HTTP auth are supported.
 
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/grafana%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/grafana/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/grafana%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/grafana/)
-
 ## Limitations
 
 * The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards!
@@ -68,20 +67,18 @@ LDAP and HTTP auth are supported.
 
 None.
 
-## Links
+## Documentation and resources
 
+* Official app website: https://grafana.com/
+* Official user documentation: https://yunohost.org/apps
+* Official admin documentation: https://yunohost.org/packaging_apps
+* Upstream app code repository: https://github.com/grafana/
+* YunoHost documentation for this app: https://yunohost.org/app_grafana
 * Report a bug: https://github.com/YunoHost-Apps/grafana_ynh/issues
- * Grafana website: https://grafana.com/
- * Grafana upstream app repository: https://github.com/grafana/
- * InfluxDB website: https://www.influxdata.com/
- * InfluxDB upstream app repository: https://github.com/influxdata/influxdb
- * YunoHost website: https://yunohost.org/
 
----
+## Developer info
 
-## Developers info
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/grafana_ynh/tree/testing).
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/grafana_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
 ```
@@ -89,3 +86,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/grafana_ynh/tree/test
 or
 sudo yunohost app upgrade grafana -u https://github.com/YunoHost-Apps/grafana_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,86 @@
+# Grafana pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/grafana.svg)](https://dash.yunohost.org/appci/app/grafana) ![](https://ci-apps.yunohost.org/ci/badges/grafana.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grafana.maintain.svg)  
+[![Installer Grafana avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grafana)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Grafana rapidement et simplement sur un serveur YunoHost.
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
+
+## Vue d'ensemble
+
+Tableaux de bords de supervision
+
+**Version incluse :** 8.0.6~ynh1
+
+**Démo :** https://play.grafana.org
+
+## Captures d'écran
+
+![](./doc/screenshots/Grafana8_Kubernetes.jpg)
+
+## Avertissements / informations importantes
+
+## Configuration
+
+**Important at first login:**
+
+* you have to go the Grafana Menu (Grafana icon), select your account menu and select *Switch to Main Org.*
+* you can now access the default NetData dashboard via the Home menu
+
+**Don't hesitate to create new dashboards**: the default dashboard contains metrics from NetData, but only generic ones that are generated on every machine. NetData dynamically detects services and applications (e.g.redis, nginx, etc.) and enriches its dashboard and generated metrics. Many NetData metrics don't appear in the provided default Grafana dashboard!
+
+## Documentation
+
+ * Official Grafana documentation: https://grafana.com/docs/grafana/latest/
+ * Official InfluxdB documentation: https://docs.influxdata.com/influxdb/
+ * YunoHost documentation: If specific documentation is needed, feel free to contribute.
+
+## YunoHost specific features
+
+* installs InfluxDB as time series database
+* if the NetData package is installed, configures NetData to feed InfluxDB every minute
+* installs Grafana as dashboard server
+* creates a Grafana Data Source to fetch data from InfluxDB (and hence NetData!)
+* creates a default dashboard to plot some data from NetData (doesn't cover every metric, can be greatly enhanced!)
+
+#### General architecture
+
+![image](https://cloud.githubusercontent.com/assets/2662304/20649711/29f182ba-b4ce-11e6-97c8-ab2c0ab59833.png)
+
+#### Multi-users support
+
+LDAP and HTTP auth are supported.
+
+## Limitations
+
+* The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards!
+* Organizations creation doesn't play well with LDAP integration; it is disabled for standard users, but can't be disabled for administrators: **please do not create organizations**!
+
+## Additional information
+
+None.
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://grafana.com/
+* Documentation officielle utilisateur : https://yunohost.org/apps
+* Documentation officielle de l'admin : https://yunohost.org/packaging_apps
+* Dépôt de code officiel de l'app : https://github.com/grafana/
+* Documentation YunoHost pour cette app : https://yunohost.org/app_grafana
+* Signaler un bug : https://github.com/YunoHost-Apps/grafana_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/grafana_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/grafana_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade grafana -u https://github.com/YunoHost-Apps/grafana_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps