Generate Readme automatically

README.md

@@ -1,20 +1,36 @@
+---
+
+<!--
+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.
+-->
+
 # MediaWiki for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/mediawiki.svg)](https://dash.yunohost.org/appci/app/mediawiki) ![](https://ci-apps.yunohost.org/ci/badges/mediawiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mediawiki.maintain.svg)
-[![Install WediaWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mediawiki)
+[![Install MediaWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mediawiki)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allow you to install MediaWiki quickly and simply on a YunoHost server.
+> *This package allows you to install MediaWiki quickly and simply on a YunoHost server.
-> If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
 
-MediaWiki is a free and open source software wiki package written in PHP, originally for use on Wikipedia.
+A free and open source software wiki package written in PHP, originally for use on Wikipedia.
 
 **Shipped version:** 1.35.2
 
-**Shipped extension versions:**
+**Demo:** https://www.wikipedia.org/, https://www.mediawiki.org/wiki/Project:Sandbox
+
+## Screenshots
+
+![](./doc/screenshots/screenshot.png)
+
+## Disclaimers / important information
+
+### Shipped extension versions
+
   * [LDAPAuthentication2](https://www.mediawiki.org/wiki/Extension:LDAPAuthentication2)
   * [LDAPAuthorization](https://www.mediawiki.org/wiki/Extension:LDAPAuthorization) (**disabled and unused for now**)
   * [LDAPGroups](https://www.mediawiki.org/wiki/Extension:LDAPGroups) (**disabled and unused for now**)
@@ -24,27 +40,6 @@ MediaWiki is a free and open source software wiki package written in PHP, origin
 
 Some of the extensions are marked as "disabled and unused" because they are not immediately required but are part of the MediaWiki "LDAP Stack" which may be needed in future versions.
 
-## Screenshots
-
-![screenshot](sources/images/screenshot.png)
-
-## Demo
-
-  * [Official demo](https://www.mediawiki.org/wiki/Project:Sandbox)
-
-## Configuration
-
-How to configure this app:
-
- * Through the admin panel: Log in then click on `Preferences`
-
-## Documentation
-
- * Official documentation: https://www.mediawiki.org
- * YunoHost documentation: https://yunohost.org/#/app_mediawiki
-
-## YunoHost specific features
-
 #### Multi-users support
 
  * Is LDAP supported?: **yes**
@@ -56,26 +51,22 @@ How to configure this app:
  * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps.yunohost.org/ci/apps/mediawiki/)
  * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mediawiki/)
 
-## Limitations
+### How to configure this app:
 
- * Any known limitations.
+ * Through the admin panel: Log in then click on `Preferences`
 
-## Additional information
+## Documentation and resources
 
- * The [Discourse forum topic](https://forum.yunohost.org/t/community-app-mediawiki-free-software-wiki-package-wikipedia/8588) tracking release schedule and feedback.
+* Official app website: https://www.mediawiki.org
+* Official user documentation: https://www.mediawiki.org/wiki/Project:Help
+* Official admin documentation: https://www.mediawiki.org/wiki/Documentation
+* Upstream app code repository:  https://github.com/wikimedia/mediawiki
+* YunoHost documentation for this app: https://yunohost.org/app_mediawiki
+* Report a bug: https://github.com/YunoHost-Apps/mediawiki_ynh/issues
 
-## Links
+## Developer info
 
- * Report a bug: https://github.com/YunoHost-Apps/mediawiki_ynh/issues
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing).
- * App website: https://www.mediawiki.org
- * Upstream app repository: https://github.com/wikimedia/mediawiki
- * YunoHost website: https://yunohost.org
-
----
-
-## Developers info
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
 ```
@@ -83,3 +74,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/mediawiki_ynh/tree/te
 or
 sudo yunohost app upgrade mediawiki -u https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -4,46 +4,35 @@
 [![Installer MediaWiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mediawiki)
 
 *[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
 
 > *Ce package vous permet d'installer MediaWiki rapidement et simplement sur un serveur YunoHost.
 Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
 
 ## Vue d'ensemble
 
-MediaWiki est un moteur de wiki pour le Web. Il est utilisé par l’ensemble des projets de la Fondation Wikimedia.
+Un wiki à base de logiciels libres Open source, développé à l’origine pour Wikipédia.
 
-**Version de Mediawiki:** 1.35.2
+**Version incluse:** 1.35.2
 
-**Versions d'extension livrées:**
+**Démo:** https://www.wikipedia.org/, https://www.mediawiki.org/wiki/Project:Sandbox
-  * [LDAPAuthentication2](https://www.mediawiki.org/wiki/Extension:LDAPAuthentication2)
-  * [LDAPAuthorization](https://www.mediawiki.org/wiki/Extension:LDAPAuthorization) (**désactivé et inutilisé pour le moment**)
-  * [LDAPGroups](https://www.mediawiki.org/wiki/Extension:LDAPGroups) (**désactivé et inutilisé pour le moment**)
-  * [LDAPUserInfo](https://www.mediawiki.org/wiki/Extension:LDAPUserInfo) (**désactivé et inutilisé pour le moment**)
-  * [LDAPProvider](https://www.mediawiki.org/wiki/Extension:LDAPProvider)
-  * [PluggableAuth](https://www.mediawiki.org/wiki/Extension:PluggableAuth)
-
-Certaines extensions sont marquées comme "désactivées et inutilisées" car elles ne sont pas immédiatement requises mais font partie de la "pile LDAP" de MediaWiki qui pourrait être nécessaire dans les versions futures.
 
 ## Captures d'écran
 
-![](sources/images/screenshot.png)
+![](./doc/screenshots/screenshot.png)
 
-## Démo
+## Avertissements / informations importantes
 
- * [Démo officielle](https://www.mediawiki.org/wiki/Project:Sandbox)
+### Extensions livrées
 
-## Configuration
+  * [LDAPAuthentication2](https://www.mediawiki.org/wiki/Extension:LDAPAuthentication2)
+  * [LDAPAuthorization](https://www.mediawiki.org/wiki/Extension:LDAPAuthorization) (**désactivée et inutilisée pour l'instant**)
+  * [LDAPGroups](https://www.mediawiki.org/wiki/Extension:LDAPGroups) (**désactivée et inutilisée pour l'instant**)
+  * [LDAPUserInfo](https://www.mediawiki.org/wiki/Extension:LDAPUserInfo) (**désactivée et inutilisée pour l'instant**)
+  * [LDAPProvider](https://www.mediawiki.org/wiki/Extension:LDAPProvider)
+  * [PluggableAuth](https://www.mediawiki.org/wiki/Extension:PluggableAuth)
 
-Comment configurer cette application :
+Certaines extensions sont marquées comme "désactivées et inutilisées" car elles font partie de la "pile LDAP" de MediaWiki qui pourrait être nécessaire dans les versions futures.
-
- * Via le panneau d'administration : Connectez-vous puis cliquez sur `Préférences`
-
-## Documentation
-
- * Documentation officielle : https://www.mediawiki.org
- * Documentation YunoHost : https://yunohost.org/#/app_mediawiki
-
-## Caractéristiques spécifiques YunoHost
 
 #### Support multi-utilisateur
 
@@ -51,27 +40,24 @@ Comment configurer cette application :
  * L'authentification HTTP est-elle prise en charge ? **Non**
  * L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
 
+
 #### Architectures supportées
 
  * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps.yunohost.org/ci/apps/mediawiki/)
  * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mediawiki/)
 
-## Limitations
+### Comment configurer cette application :
 
- * Limitations connues.
+ * Via le panneau d'administration : Connectez-vous puis cliquez sur `Préférences`
 
-## Informations additionnelles
+## Documentations et ressources
 
-  * Le [forum Discourse](https://forum.yunohost.org/t/community-app-mediawiki-free-software-wiki-package-wikipedia/8588)
+* Site officiel de l'app : https://www.mediawiki.org
-
+* Documentation officielle utilisateur: https://www.mediawiki.org/wiki/Project:Help
-## Links
+* Documentation officielle de l'admin: https://www.mediawiki.org/wiki/Documentation
-
+* Dépôt de code officiel de l'app:  https://github.com/wikimedia/mediawiki
- * Signaler un bug : https://github.com/YunoHost-Apps/mediawiki_ynh/issues
+* Documentation YunoHost pour cette app: https://yunohost.org/app_mediawiki
- * Site de l'application : https://www.mediawiki.org
+* Signaler un bug: https://github.com/YunoHost-Apps/mediawiki_ynh/issues
- * Dépôt de l'application principale : https://github.com/wikimedia/mediawiki
- * Site web YunoHost : https://yunohost.org
-
----
 
 ## Informations pour les développeurs
 
@@ -80,6 +66,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
 Pour essayer la branche testing, procédez comme suit.
 ```
 sudo yunohost app install https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing --debug
-ou
+or
 sudo yunohost app upgrade mediawiki -u https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps

doc/DISCLAIMER.md

@@ -0,0 +1,25 @@
+### Shipped extension versions
+
+  * [LDAPAuthentication2](https://www.mediawiki.org/wiki/Extension:LDAPAuthentication2)
+  * [LDAPAuthorization](https://www.mediawiki.org/wiki/Extension:LDAPAuthorization) (**disabled and unused for now**)
+  * [LDAPGroups](https://www.mediawiki.org/wiki/Extension:LDAPGroups) (**disabled and unused for now**)
+  * [LDAPUserInfo](https://www.mediawiki.org/wiki/Extension:LDAPUserInfo) (**disabled and unused for now**)
+  * [LDAPProvider](https://www.mediawiki.org/wiki/Extension:LDAPProvider)
+  * [PluggableAuth](https://www.mediawiki.org/wiki/Extension:PluggableAuth)
+
+Some of the extensions are marked as "disabled and unused" because they are not immediately required but are part of the MediaWiki "LDAP Stack" which may be needed in future versions.
+
+#### Multi-users support
+
+ * Is LDAP supported?: **yes**
+ * Is HTTP auth supported?: **no**
+ * Can the app be used by multiple users?: **yes**
+
+#### Supported architectures
+
+ * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps.yunohost.org/ci/apps/mediawiki/)
+ * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mediawiki/)
+
+### How to configure this app:
+
+ * Through the admin panel: Log in then click on `Preferences`

doc/DISCLAIMER_fr.md

@@ -0,0 +1,26 @@
+### Extensions livrées
+
+  * [LDAPAuthentication2](https://www.mediawiki.org/wiki/Extension:LDAPAuthentication2)
+  * [LDAPAuthorization](https://www.mediawiki.org/wiki/Extension:LDAPAuthorization) (**désactivée et inutilisée pour l'instant**)
+  * [LDAPGroups](https://www.mediawiki.org/wiki/Extension:LDAPGroups) (**désactivée et inutilisée pour l'instant**)
+  * [LDAPUserInfo](https://www.mediawiki.org/wiki/Extension:LDAPUserInfo) (**désactivée et inutilisée pour l'instant**)
+  * [LDAPProvider](https://www.mediawiki.org/wiki/Extension:LDAPProvider)
+  * [PluggableAuth](https://www.mediawiki.org/wiki/Extension:PluggableAuth)
+
+Certaines extensions sont marquées comme "désactivées et inutilisées" car elles font partie de la "pile LDAP" de MediaWiki qui pourrait être nécessaire dans les versions futures.
+
+#### Support multi-utilisateur
+
+ * L'authentification LDAP est-elle prise en charge ? **Oui**
+ * L'authentification HTTP est-elle prise en charge ? **Non**
+ * L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
+
+
+#### Architectures supportées
+
+ * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps.yunohost.org/ci/apps/mediawiki/)
+ * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mediawiki/)
+
+### Comment configurer cette application :
+
+ * Via le panneau d'administration : Connectez-vous puis cliquez sur `Préférences`

manifest.json

@@ -9,6 +9,15 @@
     "version": "1.35.2~ynh1",
     "url": "https://www.mediawiki.org",
     "license": "GPL-2.0-or-later",
+    "upstream": {
+        "license": "GPL-2.0-or-later",
+        "website": "https://www.mediawiki.org",
+        "demo": "https://www.wikipedia.org/, https://www.mediawiki.org/wiki/Project:Sandbox",
+        "admindoc": "https://www.mediawiki.org/wiki/Documentation",
+        "userdoc": "https://www.mediawiki.org/wiki/Project:Help",
+        "code": "https://github.com/wikimedia/mediawiki",
+        "version": "1.35.2"
+    },
     "maintainer": {
         "name": "Salamandar",
         "email": "felix@piedallu.me"