diff --git a/dev.md b/dev.md index e76fda01..645915a6 100644 --- a/dev.md +++ b/dev.md @@ -7,7 +7,7 @@ contribution process. If you're looking for stuff to implement or fix, the bug-tracker is [here](https://github.com/YunoHost/issues/issues) ! -**Come say hi to us in the [dev chatroom](xmpp:dev@conference.yunohost.org?join)** ! If you don't have an XMPP client, you can join using the widget at the bottom right of this page. +**Come say hi to us in the [dev chatroom](/chat_rooms)** ! ### Setting up a development environment @@ -19,16 +19,16 @@ If you're looking for stuff to implement or fix, the bug-tracker is - **Implement and test your feature**. Depending on what you want to develop, you will want to : - - **Python/CLI core** : work in `/vagrant/yunohost/` - - **Web administration interface** : work in `/vagrant/yunohost-admin/` + - **Python/CLI core** : work in `/ynh-dev/yunohost/` + - **Web administration interface** : work in `/ynh-dev/yunohost-admin/` - You can also work on the other projects on which YunoHost is built (SSOwat, moulinette) in similar ways ### Working on the YunoHost Python/CLI core -- Work in `/vagrant/yunohost/`. +- Work in `/ynh-dev/yunohost/`. -- Run `/vagrant/ynh-dev use-git yunohost`. +- Run `cd /ynh_dev/ && ./ynh-dev use-git yunohost`. - The actionsmap file (`data/actionsmap/yunohost.yml`) defines the various categories, actions and arguments of the yunohost CLI. Define how you want @@ -45,7 +45,7 @@ If you're looking for stuff to implement or fix, the bug-tracker is ##### Helpers / coding style -- To handle exceptions, you should raise some `MoulinetteError()` +- To handle exceptions, you should raise some `YunohostError()` - To help with internationalizing the messages, use `m18n.n('some-message-id')` and put your string in `locales/en.json`. You can also put arguments and use @@ -57,17 +57,11 @@ If you're looking for stuff to implement or fix, the bug-tracker is - Name of "private" functions should start with a `_` -##### Don't forget - -- (Might not be necessary anymore) Each time you edit the actionsmap, you should - force the refresh of the cache with `rm - /var/cache/moulinette/actionsmap/yunohost.pkl` - ### Working on the YunoHost web administration interface -- Work in `/vagrant/yunohost-admin/src/`. +- Work in `/ynh-dev/yunohost-admin/src/`. -- Run `/vagrant/ynh-dev use-git yunohost-admin`. It launches gulp, such as each +- Run `cd /ynh-dev && ./ynh-dev use-git yunohost-admin`. It launches gulp, such as each time you modify sources, it recompiles the code and you can use it by refreshing (Ctrl+F5) your web administration. To stop the command, just do Ctrl+C. @@ -111,14 +105,12 @@ If you're looking for stuff to implement or fix, the bug-tracker is - Fork the relevant repo on Github, and commit stuff to a new branch. We recommend to name the branch with the following convention : - - For an enhancement or new feature : `enh-REDMINETICKET-name-of-feature` - - For a bugfix `fix-REDMINETICKET-description-of-fix` - - `REDMINETICKET` is optional and is the id of a corresponding ticket on RedMine. + - For an enhancement or new feature : `enh-ISSUENUMBER-name-of-feature` + - For a bugfix `fix-ISSUENUMBER-description-of-fix` + - `ISSUENUMBER` is optional and is the id of a corresponding ticket on the bug tracker. - Once you're ready, open a Pull Request (PR) on Github. Please include `[fix]` or `[enh]` at the beginning of the title of your PR. - After reviewing, testing and validation by other contributors, your branch -should be merged in `testing` (?) ! - - +should be merged in `unstable` ! diff --git a/dev_fr.md b/dev_fr.md index 2cfa4cd8..d161888c 100644 --- a/dev_fr.md +++ b/dev_fr.md @@ -7,9 +7,7 @@ processus de contribution. Si vous chercher quelque chose à implémenter ou un bug à réparer, le bug tracker est [ici](https://github.com/yunohost/issues/issues) ! -**Venez dire coucou sur le [salon de -dev](xmpp:dev@conference.yunohost.org?join)** ! Si vous n'avez pas de client -XMPP, vous devriez pouvoir vous connecter à l'aide du widget en bas de la page. +**Venez dire coucou sur le [salon de dev](/chat_rooms)** ! ### Mettre en place un environnement de développement @@ -23,16 +21,16 @@ XMPP, vous devriez pouvoir vous connecter à l'aide du widget en bas de la page. - **Implémentez et testez votre fonctionnalité**. Suivant ce sur quoi vous voulez travailler : - - **Cœur Python/ligne de comande** : allez dans `/vagrant/yunohost/` - - **Interface d'administration web** : allez dans `/vagrant/yunohost-admin/` + - **Cœur Python/ligne de comande** : allez dans `/ynh-dev/yunohost/` + - **Interface d'administration web** : allez dans `/ynh-dev/yunohost-admin/` - Vous pouvez aussi travailler sur les autres projets liés sur lesquels s'appuie YunoHost (SSOwat, moulinette) de façon similaire. ### Travailler sur le cœur Python / ligne de commande -- Allez dans `/vagrant/yunohost/`. +- Allez dans `/ynh-dev/yunohost/`. -- Exécutez `/vagrant/ynh-dev use-git yunohost`. +- Exécutez `cd /ynh-dev && ./ynh-dev use-git yunohost`. - Le fichier actionsmap (`data/actionsmap/yunohost.yml`) définit les différentes catégories, actions et arguments de la ligne de commande YunoHost. Choisissez @@ -49,7 +47,7 @@ XMPP, vous devriez pouvoir vous connecter à l'aide du widget en bas de la page. ##### Helpers / style de code -- Pour gérer les exceptions, il existe un type `MoulinetteError()` +- Pour gérer les exceptions, il existe un type `YunohostError()` - Pour aider avec l'internationalisation des messages, utilisez `m18n.n('some-message-id')` et mettez le message correspondant dans `locales/en.json`. Vous pouvez aussi @@ -62,17 +60,11 @@ XMPP, vous devriez pouvoir vous connecter à l'aide du widget en bas de la page. - Mettre un `_` devant les noms des fonctions "privées". -##### N'oubliez pas - -- (Peut-être plus nécessaire) À chaque fois que vous modifiez l'actionsmap, il - faut forcer le rafraîchissement du cache avec : - `rm /var/cache/moulinette/actionsmap/yunohost.pkl` - ### Travailler sur l'interface d'administration web -- Allez dans `/vagrant/yunohost-admin/src/`. +- Allez dans `/ynh-dev/yunohost-admin/src/`. -- Exécutez `/vagrant/ynh-dev use-git yunohost-admin`. Ceci lance gulp, de sorte +- Exécutez `cd /ynh-dev && ./ynh-dev use-git yunohost-admin`. Ceci lance gulp, de sorte qu'à chaque fois que vous modifiez les sources, il recompilera le code (js) et vous pourrez voir les changements dans le navigateur web (Ctrl+F5). Pour stopper la commande, faites simplement Ctrl+C. @@ -121,14 +113,14 @@ XMPP, vous devriez pouvoir vous connecter à l'aide du widget en bas de la page. - Forkez le dépòt correspondant sur Github, et commitez vos changements dans une nouvelle branche, Il est recommandé de nommer la branche avec la convention : - - Pour une nouvelle fonctionnalité ou amélioration : `enh-TICKETREDMINE-description-fonctionnalité` + - Pour une nouvelle fonctionnalité ou amélioration : `enh-ISSUENUMBER-description-fonctionnalité` - Pour une correction de bug : `fix-REDMINETICKET-description-correctif` - - `TICKETREDMINE` est optionnel et correspond au numéro du ticket sur RedMine + - `ISSUENUMBER` est optionnel et correspond au numéro du ticket sur le bug tracker - Une fois prêt, ouvrez une Pull Request (PR) sur Github. De préférence, inclure `[fix]` ou `[enh]` au début du titre de la PR. - Après relecture, test et validation par les autres contributeurs, votre - branche sera mergée dans `testing` (?) ! + branche sera mergée dans `unstable` ! diff --git a/images/images.list b/images/images.list index 585a521b..9b1cf3f4 100644 --- a/images/images.list +++ b/images/images.list @@ -27,6 +27,7 @@ Linuxfr.png logo-jirafeau.jpeg logo.png Logo-wallabag-svg.svg +lxc.png mailview.jpg webadmin.png webadmin_fr.png @@ -55,7 +56,6 @@ transmission.png ttrss.png unetbootin.png usb_key.png -vagrant.png virtualbox_1.png virtualbox_2.1.png virtualbox_2.png diff --git a/images/lxc.png b/images/lxc.png new file mode 100644 index 00000000..e344c1dd Binary files /dev/null and b/images/lxc.png differ diff --git a/images/vagrant.png b/images/vagrant.png deleted file mode 100644 index 8a04afb1..00000000 Binary files a/images/vagrant.png and /dev/null differ diff --git a/install.md b/install.md index 20c957d8..5e768242 100644 --- a/install.md +++ b/install.md @@ -74,15 +74,13 @@ This page lists a few installation guides.
-
-

On Vagrant

 -
-

On Debian 9/Stretch
+
+

Dev environment in LXD/LXC
-
+
diff --git a/install_ar.md b/install_ar.md index 5411c784..65c5dde5 100644 --- a/install_ar.md +++ b/install_ar.md @@ -71,13 +71,13 @@
-
-

على فاغرانت

 -
-

على ديبيان 9 / ستريتش
+
+

Dev environment in LXD/LXC

 +
+
diff --git a/install_es.md b/install_es.md index 0550dab8..3c3fb448 100644 --- a/install_es.md +++ b/install_es.md @@ -68,13 +68,14 @@ Esta página enumera varios tipos de instalaciones, clasificados por categorías
-
-

Con Vagrant

 -
-

Sur Debian 9/Stretch
+
+

Dev environment in LXD/LXC

 +
+ +
diff --git a/install_fr.md b/install_fr.md index 21f08906..60612125 100644 --- a/install_fr.md +++ b/install_fr.md @@ -68,13 +68,13 @@ Cette page liste plusieurs types d’installations, classés par catégories.
-
-

Avec Vagrant

 -
-

Sur Debian 9/Stretch
+
+

Environnement de dev avec LXD/LXC

 +
+
diff --git a/install_it.md b/install_it.md index 1a1d18e4..8fa8f550 100644 --- a/install_it.md +++ b/install_it.md @@ -76,12 +76,12 @@ Questa pagina elenca alcune guide all'installazione.
-

Su Vagrant

 + +

Su Debian 9/Stretch
- -

Su Debian 9/Stretch

 +

Dev environment in LXD/LXC
diff --git a/troubleshooting_guide.md b/troubleshooting_guide.md index fec52ddb..50683619 100644 --- a/troubleshooting_guide.md +++ b/troubleshooting_guide.md @@ -5,7 +5,7 @@ You can consider this as some kind of administrator guide for troubleshooting or ## General notes ### Do not break YunoHost Best way to troubleshoot is to not have to troubleshoot because you have tested everything before deploying it on your server. -This means that everytime you want to try a new thing (non-official app, new specific config, package an app...), you should try it on a development or testing instance, *not* on your production server. For this, you can [set up a Vagrant box](vagrant), or for instance a [DigitalOcean droplet](install_on_vps) for 1 cent/hour. +This means that everytime you want to try a new thing (non-official app, new specific config, package an app...), you should try it on a development or testing instance, *not* on your production server. For this, you can [set up a virtualbox](install_on_virtualbox), or for instance a [DigitalOcean droplet](install_on_vps) for 1 cent/hour. Also: https://wiki.debian.org/DontBreakDebian diff --git a/troubleshooting_guide_fr.md b/troubleshooting_guide_fr.md index 31e516b7..2f107da0 100644 --- a/troubleshooting_guide_fr.md +++ b/troubleshooting_guide_fr.md @@ -5,7 +5,7 @@ Ce guide peut trouver son intérêt lors du débuggage d’une nouvelle applicat ## Notes générales ### Ne cassez pas YunoHost -La meilleure manière de ne pas avoir de pannes est de ne pas bricoler sur votre serveur. Cela signifie que dès que vous souhaitez essayer quelque chose de nouveau (application non officielle, nouvelle configuration personnalisée, création d’une nouvelle application), essayez d'abord cela sur un serveur de test et non de production. Pour faire cela, vous pouvez par exemple utiliser une [box Vagrant](vagrant_fr) ou un [droplet DigitalOcean](install_on_vps_fr) pour 1 centime/heure. +La meilleure manière de ne pas avoir de pannes est de ne pas bricoler sur votre serveur. Cela signifie que dès que vous souhaitez essayer quelque chose de nouveau (application non officielle, nouvelle configuration personnalisée, création d’une nouvelle application), essayez d'abord cela sur un serveur de test et non de production. Pour faire cela, vous pouvez par exemple utiliser une [virtualbox](install_on_virtualbox_fr) ou un [droplet DigitalOcean](install_on_vps_fr) pour 1 centime/heure. Vous pouvez aussi lire ceci si vous avez encore envie de bricoler sur votre instance YunoHost en production : https://wiki.debian.org/DontBreakDebian diff --git a/vagrant.md b/vagrant.md deleted file mode 100644 index fa165cdf..00000000 --- a/vagrant.md +++ /dev/null @@ -1,59 +0,0 @@ -# Vagrant and YunoHost - -*If you need testing some code, you should using directly [ynh-dev](https://github.com/yunohost/ynh-dev)* - -*Find other ways to install YunoHost **[here](/install)**.* - - - -**Prerequisite**: an x86 computer with VirtualBox installed and enough RAM capacity to be able to run a small virtual machine. - ---- - -## Initialization - -Create a project folder -```bash -mkdir YunoHost -cd YunoHost -``` - -The following command will initialize the project with a Yunohost image -```bash -vagrant box add yunohost/stretch-unstable https://build.yunohost.org/yunohost-stretch-unstable.box --provider virtualbox -vagrant init yunohost/stretch-unstable -``` - -You need to activate the network for the YunoHost instance. -```bash -sed -i 's/# config\.vm\.network "private_network"/config.vm.network "private_network"/' Vagrantfile``` - ---- - -## Run a vm - -Start the virtual machine -```bash -vagrant up -``` - -Connect to the started virtual machine -```bash -vagrant ssh -``` - -Upgrade the system -```bash -sudo apt update && sudo apt dist-upgrade -``` - -You can access to your vm with the ip 192.168.33.10 - -The IP addresses related to the boxes are set by default but can be changed in the network settings. - ---- - -*Once the installation is finished, you may want to proceed to post-installation: **[yunohost.org/postinstall](/postinstall)** * - - - diff --git a/vagrant_es.md b/vagrant_es.md deleted file mode 100644 index 2edf6375..00000000 --- a/vagrant_es.md +++ /dev/null @@ -1,60 +0,0 @@ -# Vagrant y YunoHost - -*Si necesitas una máquina virtual para testar tu código, es mejor utilizar directamente [ynh-dev](https://github.com/yunohost/ynh-dev)* - -*Encontrar otros medios de instalar Yunohost **[aquí](/install_es)**.* - - - -**Prerrequisitos** : Un ordenador x86 con VirtualBox instalado y bastante RAM disponible para iniciar una pequeña máquina virtual. - ---- - -## Inicio - -Crear una carpeta para el proyecto : -```bash -mkdir YunoHost -cd YunoHost -``` - -El comando siguiente iniciará el proyecto con una imagen básica de Yunohost -```bash -vagrant box add yunohost/stretch-unstable https://build.yunohost.org/yunohost-stretch-unstable.box --provider virtualbox -vagrant init yunohost/stretch-unstable -``` -Luego, tienes que activar la red para la instancia Yunohost : -```bash -sed -i 's/# config\.vm\.network "private_network"/config.vm.network "private_network"/' Vagrantfile -``` - ---- - -## Instalación - -Iniciar la máquina virtual -```bash -vagrant up -``` - -Conectarse a la máquina virtual iniciada -```bash -vagrant ssh -``` - -Actualizar el sistema. -```bash -apt update && apt dist-upgrade -``` - -Puedes acceder a tu VM vía el IP 192.168.33.10. - -Las direcciones IP están asignadas por defecto pero pueden ser cambiadas en los parámetros de red del Vagrantfile. - ---- - -*Una vez la instalación terminada, puedes proceder a la post-instalación : -**[yunohost.org/postinstall](/postinstall_es)** * - - - diff --git a/vagrant_fr.md b/vagrant_fr.md deleted file mode 100644 index ebb0da31..00000000 --- a/vagrant_fr.md +++ /dev/null @@ -1,59 +0,0 @@ -# Vagrant et YunoHost - -*Si vous avez besoin d’une vm pour tester du code, il vaut mieux utiliser directement [ynh-dev](https://github.com/yunohost/ynh-dev)* - -*Toutes les autres façons d’installer YunoHost sont listées **[ici](/install_fr)**.* - - - -**Prérequis** : Un ordinateur x86 avec VirtualBox installé et assez de RAM disponible pour lancer une petite machine virtuelle. - ---- - -## Initialisation - -Créer un dossier pour le projet : -```bash -mkdir YunoHost -cd YunoHost -``` - -La commande suivante va initialiser le projet avec une image YunoHost de base -```bash -vagrant box add yunohost/stretch-unstable https://build.yunohost.org/yunohost-stretch-unstable.box --provider virtualbox -vagrant init yunohost/stretch-unstable -``` -Puis, il faut activer le réseau pour l'instance YunoHost: -```bash -sed -i 's/# config\.vm\.network "private_network"/config.vm.network "private_network"/' Vagrantfile -``` - ---- - -## Installation - -Démarrer la machine virtuelle -```bash -vagrant up -``` - -Se connecter à la machine virtuelle démarrée -```bash -vagrant ssh -``` - -Mettre à jour le système. -```bash -apt update && apt dist-upgrade -``` - -Vous pouvez accéder à votre vm via l’ip 192.168.33.10. - -Les adresses IP sont assignées par défaut mais peuvent être changées dans les paramètres réseau du Vagrantfile. - ---- - -*Une fois l’installation terminée, vous pouvez procéder à la post-installation : **[yunohost.org/postinstall](/postinstall_fr)** * - - -