From 64d2d01636959a4dc9cf0b0d4d253bfe8432ca47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marie-Mich=C3=A8le=20Poulin?= Date: Tue, 20 Jul 2021 16:19:01 -0400 Subject: [PATCH] [FIX] Doc: grammar and spelling correction. --- README.md | 6 +- doc/CODE_GENERATOR.base.md | 232 ++++++++++++++++++------------------- doc/DEVELOPMENT.md | 16 +-- doc/GIT_REPO.md | 10 +- doc/POETRY.md | 4 +- doc/PRODUCTION.md | 14 +-- doc/RELEASE.md | 15 +-- 7 files changed, 149 insertions(+), 148 deletions(-) diff --git a/README.md b/README.md index 747d535..2ec5c8b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # ERPLibre documentation -Select a guide to install your environment! +Select a guide to install your environment. ## Easy way to run locally -Clone the project +Clone the project: ```bash git clone https://github.com/ERPLibre/ERPLibre.git cd ERPLibre @@ -16,7 +16,7 @@ Update your configuration if you need to run from another interface than 127.0.0 #xmlrpc_interface = 127.0.0.1 #netrpc_interface = 127.0.0.1 ``` -Ready to execute +Ready to execute: ```bash make run ``` diff --git a/doc/CODE_GENERATOR.base.md b/doc/CODE_GENERATOR.base.md index 95ea584..ad720ac 100644 --- a/doc/CODE_GENERATOR.base.md +++ b/doc/CODE_GENERATOR.base.md @@ -12,10 +12,10 @@ Never run this on production environment, this create circular dependencies and will cause frustration to clean damage. -Ne jamais exécuter le générateur de code dans un environnement de production, il y a création de dépendance circulaire pouvant causer de la frustration à nettoyer tous les dommages. D'ailleurs, il est nécessaire d'exécuter en mode développement, avec l'argument `--dev all`. +Ne jamais exécuter le générateur de code dans un environnement de production, il y a création de dépendances circulaires pouvant causer de la frustration à nettoyer tous les dommages. D'ailleurs, il est nécessaire d'exécuter en mode développement, avec l'argument `--dev all`. L'objectif du générateur de code est de : -- utilisation du générateur via l'interface web; +- utiliser le générateur via l'interface web; - créer un nouveau module; - modifier un module existant; - exécuter les tests. @@ -24,7 +24,7 @@ Ce générateur de code, pour ERPLibre, a tout avantage d'être sous licence AGP - (Utiliser) L'utilisation de module sans restriction; - (Copier) Copier des modules pour faciliter leur maintenance et leur pérennité; - (Étudier) De comprendre le comportement des fonctionnalités; -- (Modifier) Modifier un module existant pour l'améliorer et pouvoir le redistribuer à la communauté; +- (Modifier) Modifier un module existant pour l'améliorer et devoir le redistribuer à la communauté; ``` @@ -40,16 +40,16 @@ Modules 3. A Template reads a Module to generate a Code_Generator. -Il y a 3 types de module dans le contexte du générateur de code : -1. [A Template generates a Template or a Code_Generator.](#crer-votre-premier-code_generator), le chef d'orchestre qui permet de gérer plusieurs générateur de code. +Il y a 3 types de modules dans le contexte du générateur de code : +1. [A Template generates a Template or a Code_Generator.](#crer-votre-premier-code_generator), le chef d'orchestre qui permet de gérer plusieurs générateurs de code. 2. Un Code_Generator génère un module, c'est un moule à module généré. 3. Un Template lit un module pour générer un Code_Generator. -Warning, be careful to your code, always commit after a manipulation, because the mode enable_sync_code erase data, only the git will save you! +Warning, be careful with your code, always commit after a manipulation, because the mode enable_sync_code erase data, only Git will save you! -Attention pour ne pas écraser votre code, toujours commiter après une manipulation, l'utilisation du mode enable_sync_code peut effacer des données. Seul git vous sauvera! +Attention pour ne pas écraser votre code, toujours commiter après une manipulation, l'utilisation du mode enable_sync_code peut effacer des données. Seul Git vous sauvera! ## Manual generator with web interface @@ -91,7 +91,7 @@ make addons_install_code_generator_full make run_code_generator ``` -Ouvrir le navigateur sur [http://localhost:8069](http://localhost:8069). Utilisateur `test` et mot de passe `test`. Une fois connecté, ouvrir sur [http://localhost:8069/web?debug=](http://localhost:8069/web?debug=) pour activer le déverminage. +Ouvrir le navigateur sur [http://localhost:8069](http://localhost:8069). Utilisateur `test` et mot de passe `test`. Une fois connecté, ouvrir sur [http://localhost:8069/web?debug=](http://localhost:8069/web?debug=) pour activer le mode déverminage. Ouvrir l'application `Code Generator` et créer un `Module`. Remplir les champs requis et générer avec `Action/Generate code`. @@ -111,7 +111,7 @@ make run_code_generator TODO -Pour des références techniques, voir module : +Pour des références techniques, voir modules : - code_generator_template_demo_portal - code_generator_demo_portal - code_generator_demo_internal @@ -122,12 +122,12 @@ Pour des références techniques, voir module : TODO -Aller dans le module «Code generator» et créer un module «test». -- Sur l'onglet «Information», activer «Enable Sync Code» -- Sur l'onglet «Technical Data», activer «Application». -- Sur l'onglet «Elements»/«Models», ajouter un modèle et sauvegarder. +Aller dans le module «Code generator» et créer un module «test»; +- Sur l'onglet «Information», activer «Enable Sync Code»; +- Sur l'onglet «Technical Data», activer «Application»; +- Sur l'onglet «Elements»/«Models», ajouter un modèle et sauvegarder; - Appuyer sur le bouton «Views» - - Appuyer «Generate» + - Appuyer «Generate». Générer le module avec «Action/Générer code». @@ -155,7 +155,7 @@ make run_code_generator TODO -Pour des références techniques, voir module : +Pour des références techniques, voir modules : - code_generator_template_demo_portal - code_generator_demo_portal - code_generator_demo_internal @@ -166,15 +166,15 @@ Pour des références techniques, voir module : TODO -Aller dans le module «Code generator» et créer un module «test». -- Sur l'onglet «Information», activer «Enable Sync Code» -- Sur l'onglet «Technical Data», activer «Application». -- Sur l'onglet «Elements»/«Models», ajouter un modèle et sauvegarder. +Aller dans le module «Code generator» et créer un module «test»; +- Sur l'onglet «Information», activer «Enable Sync Code»; +- Sur l'onglet «Technical Data», activer «Application»; +- Sur l'onglet «Elements»/«Models», ajouter un modèle et sauvegarder; - Appuyer sur le bouton «Views» - Désactiver «Enable all feature» - Dans l'onglet «Portal» - Activer «Enable portal feature» - - Appuyer «Generate» + - Appuyer «Generate». Générer le module avec «Action/Générer code». @@ -203,10 +203,10 @@ Aller sur le portail pour visualiser les données, à l'adresse `/my`. TODO -Le crochet nommé «hook» permet d'exécuter du code en -- Pré-initialisation du module -- Post-initialisation du module -- Désinstallation du module +Le crochet nommé «hook» permet d'exécuter du code en: +- Pré-initialisation du module; +- Post-initialisation du module; +- Désinstallation du module. Pour des références techniques, voir module : - code_generator_demo @@ -223,10 +223,10 @@ TODO Aller dans le module «Code generator» et créer un module «test». -- Sur l'onglet «Information», activer «Enable Sync Code» -- Sur l'onglet «Hook» +- Sur l'onglet «Information», activer «Enable Sync Code»; +- Sur l'onglet «Hook»: - Activer «Show post_init_hook» - - Ajouter le code suivant dans la fenêtre qui est apparu : + - Ajouter le code suivant dans la fenêtre qui est apparue : ```python @@ -260,9 +260,9 @@ TODO Permettre d'exécuter du code basé sur des séquences de temps ou des moments spécifiques à répétition. Pour des références techniques, voir module : -- code_generator_template_demo_sysadmin_cron -- code_generator_auto_backup -- auto_backup +- code_generator_template_demo_sysadmin_cron; +- code_generator_auto_backup; +- auto_backup. ```bash @@ -276,13 +276,13 @@ TODO Aller dans le module «Code generator» et créer un module «test». -- Sur l'onglet «Information», activer «Enable Sync Code» -- Sur l'onglet «Cron» +- Sur l'onglet «Information», activer «Enable Sync Code»; +- Sur l'onglet «Cron»: - Ajouter un cron - - Choisir le «Modèle» : «Contact» - - Choisir unité de temps en «Minutes» dans «Exécuter tous les» - - Modifier «Nombre d'appel» à -1 pour exécution sans arrêt. - - Activer «Force nextcall» pour permettre que l'interval soit basé sur le moment d'installation du module + - Choisir le «Modèle» : «Contact»; + - Choisir unité de temps en «Minutes» dans «Exécuter tous les»; + - Modifier «Nombre d'appel» à -1 pour exécution sans arrêt; + - Activer «Force nextcall» pour permettre que l'interval soit basé sur le moment d'installation du module. - Ajouter le code : @@ -307,7 +307,7 @@ make run_test TODO -Avec les outils développeur, aller regarder les logs dans l'application «Configuration»/Technique/«Structure de base de donnée»/Historisation. Des informations dans le temps apparaîtront avec le mot «Coucou». +Avec les outils développeur, aller regarder les logs dans l'application «Configuration»/Technique/«Structure de base de données»/Historisation. Des informations dans le temps apparaîtront avec le mot «Coucou». ### Create website snippet module @@ -333,9 +333,9 @@ TODO Pour des références techniques, voir module : -- code_generator_template_demo_website_snippet -- code_generator_demo_website_snippet -- demo_website_snippet +- code_generator_template_demo_website_snippet; +- code_generator_demo_website_snippet; +- demo_website_snippet. Puis dans le repo addons/ERPLibre_erplibre_theme_addons, branche code_generator_erplibre_website_snippets - code_generator_erplibre_website_snippets @@ -350,10 +350,10 @@ Aller dans le module «Code generator» et créer un module «test». TODO Incomplet -### Create geoengine with Leaflet module +### Create GeoEngine with Leaflet module -### Créer un module de gestion de coordonnée géospatial avec Leaflet +### Créer un module de gestion de coordonnées géospatiales avec Leaflet ```bash @@ -367,31 +367,31 @@ TODO Pour des références techniques, voir module : -- code_generator_demo_website_leaflet -- demo_website_leaflet +- code_generator_demo_website_leaflet; +- demo_website_leaflet. TODO -Aller dans le module «Code generator» et créer un module «test». -- Sur l'onglet «Information», activer «Enable Sync Code» -- Sur l'onglet «Technical Data» - - Activer «Application» - - Ajouter la dépendance du geo_engine «Geospatial support for System» -- Sur l'onglet «Elements»/«Models» - - Ajouter un modèle «test» - - Ajouter un champs de type «geo_». Le «geo_point» fonctionne bien. Si vous ajoutez plusieurs géométrie, tel que «geo_point», «geo_line» et «geo_polygon», il faut ajouter le champs «type» avec les valeurs du nom des champs choisis en option de sélection, exemple `[('geo_point', 'Geo Point'),('geo_polygon', 'Geo Polygon')]` - - Ajouter le champs optionnel «html_text» de type «html» pour pouvoir afficher du texte dessus. -- Appuyer sur le bouton «Controllers» - - Ajouter le modèle du module actuel, «test» - - Appuyer «Generate» -- Appuyer sur le bouton «Views» - - Désactiver «Enable all feature» - - Dans l'onglet «Website» - - Activer «Enable website leaflet feature» - - Activer «Enable geoengine feature» - - Appuyer «Generate» +Aller dans le module «Code generator» et créer un module «test»: +- Sur l'onglet «Information», activer «Enable Sync Code»; +- Sur l'onglet «Technical Data»: + - Activer «Application»; + - Ajouter la dépendance du geo_engine «Geospatial support for System»; +- Sur l'onglet «Elements»/«Models»: + - Ajouter un modèle «test»; + - Ajouter un champs de type «geo_». Le «geo_point» fonctionne bien. Si vous ajoutez plusieurs géométries, telles que «geo_point», «geo_line» et «geo_polygon», il faut ajouter le champs nommé «type» au type sélection avec les valeurs du nom des champs choisis en option de sélection, exemple `[('geo_point', 'Geo Point'),('geo_polygon', 'Geo Polygon')]` + - Ajouter le champs optionnel «html_text» de type «html» pour pouvoir afficher du texte dedans. +- Appuyer sur le bouton «Controllers»: + - Ajouter le modèle du module actuel, «test»; + - Appuyer «Generate». +- Appuyer sur le bouton «Views»: + - Désactiver «Enable all feature»; + - Dans l'onglet «Website»: + - Activer «Enable website leaflet feature»; + - Activer «Enable geoengine feature»; + - Appuyer «Generate». Générer le module avec «Action/Générer code». @@ -423,7 +423,7 @@ TODO Pour des références techniques, voir module : -- code_generator_demo_theme_website +- code_generator_demo_theme_website. ```bash @@ -435,13 +435,13 @@ make run_code_generator TODO -Aller dans le module «Code generator» et créer un module «test». -- Sur l'onglet «Information», activer «Enable Sync Code» -- Sur l'onglet «Technical Data», activer «Website theme». -- Appuyer sur le bouton «Views» - - Aller à l'onglet «theme_website» - - Mettre les couleurs désirés - - Appuyer «Generate» +Aller dans le module «Code generator» et créer un module «test»: +- Sur l'onglet «Information», activer «Enable Sync Code»; +- Sur l'onglet «Technical Data», activer «Website theme»; +- Appuyer sur le bouton «Views»: + - Aller à l'onglet «theme_website»: + - Mettre les couleurs désirés; + - Appuyer «Generate». Générer le module avec «Action/Générer code». @@ -458,7 +458,7 @@ make run_test TODO -Aller dans l'interface web, Application «Configuration», «Paramètres Généraux»/«Site Web»/«Choisissez un thème». Installer le thème «TEST». Puis aller la page du site web, les couleurs sont dans «Personnaliser»/«Personnaliser le thème». +Aller dans l'interface web, Application «Configuration», «Paramètres Généraux»/«Site Web»/«Choisissez un thème». Installer le thème «TEST», puis aller la page du site web, les couleurs sont dans «Personnaliser»/«Personnaliser le thème». ### Extract data to module @@ -470,13 +470,13 @@ Aller dans l'interface web, Application «Configuration», «Paramètres Génér TODO -L'exemple est avec le helpdesk. Installer le module helpdesk_mgmt : +L'exemple est consrtuit avec le helpdesk. Installer le module helpdesk_mgmt : Pour des références techniques, voir module : -- code_generator_demo_export_helpdesk -- code_generator_demo_export_website -- demo_website_data -- demo_helpdesk_data +- code_generator_demo_export_helpdesk; +- code_generator_demo_export_website; +- demo_website_data; +- demo_helpdesk_data. ```bash @@ -490,18 +490,18 @@ TODO Créer un ticket dans l'application «Helpdesk» dans l'interface web. -Aller dans le module «Code generator» et créer un module «test». -- Sur l'onglet «Information», activer «Enable Sync Code» -- Sur l'onglet «Technical Data», activer «Only export data». -- Appuyer sur le bouton «Models» +Aller dans le module «Code generator» et créer un module «test»: +- Sur l'onglet «Information», activer «Enable Sync Code»; +- Sur l'onglet «Technical Data», activer «Only export data»; +- Appuyer sur le bouton «Models»: - Choisissez dans «Models» : - - «helpdesk.ticket» - - Activer «Clear field blacklisted» - - Enlever les éléments suivant de «Fields» : - - name - - description - - number - - Appuyer «Generate» + - «helpdesk.ticket»; + - Activer «Clear field blacklisted»; + - Enlever les éléments suivants de «Fields» : + - name; + - description; + - number; + - Appuyer «Generate». Générer le module avec «Action/Générer code». @@ -510,10 +510,10 @@ make db_restore_erplibre_base_db_test_module_test ``` -### Migrate external database into module of migration +### Migrate external database into the migration module -### Migrer une base de donnée externe en module de migration +### Migrer une base de données externe en module de migration TODO @@ -534,7 +534,7 @@ make run_code_generator TODO -Aller dans le module «Code generator», menu «Databases»/«Databases» et créer un connecteur vers une base de donnée. +Aller dans le module «Code generator», menu «Databases»/«Databases» et créer un connecteur vers une base de données. À compléter... @@ -542,7 +542,7 @@ Aller dans le module «Code generator», menu «Databases»/«Databases» et cr ### Migrate from website to model with PDF data -### Migrer d'un site web vers un modèle de donnée avec des données format PDF +### Migrer d'un site web vers un modèle de données avec des données format PDF TODO @@ -550,13 +550,13 @@ TODO En progression, ce n'est pas encore supporté via l'interface web. -Cette technique permet d'aller lire du Javascript sur un site web pour lire ensuite le HTML, c'est à dire la vue, et en comprendre l'information pour créer un modèle. +Cette technique permet d'aller lire du Javascript sur un site web pour lire ensuite le HTML, c'est-à-dire la vue, et en comprendre l'information, pour créer un modèle. Pour des références techniques, voir module : -- code_generator_demo_converter_js -- business_plan_import_pdf +- code_generator_demo_converter_js; +- business_plan_import_pdf. -Attention, il faut mettre à jour les variables, dans les fichiers hook.py qui permettront d'extraire des données sur le site web à copier. Aucun exemple public n'est accessible pour le moment. +Attention, il faut mettre à jour les variables, dans les fichiers hook.py, qui permettront d'extraire des données sur le site web à copier. Aucun exemple public n'est accessible pour le moment. ```bash @@ -573,10 +573,10 @@ make db_restore_erplibre_base_db_test ## Préparer une BD -This will destroy and create database named `code_generator`. +This will destroy and create a database named `code_generator`. -Ceci va détruire et créer une base de donnée nommé `code_generator`. +Ceci va détruire et créer une base de données nommée `code_generator`. ```bash @@ -587,7 +587,7 @@ make db_restore_erplibre_base_db_code_generator TODO -Pour de meilleur performance d'exécution, réduire la quantité de «repo addons» permet d'accélérer l'installation, exécuter : +Pour de meilleures performances d'exécution, réduire la quantité de «repo addons» qui permet d'accélérer l'installation, exécuter : ```bash @@ -598,7 +598,7 @@ make config_gen_code_generator TODO -Pour revenir à la configuration normal, en production, exécuter : +Pour revenir à la configuration normale, en production, exécuter : ```bash @@ -624,9 +624,9 @@ Modifier [Code Generator Demo](./../addons/TechnoLibre_odoo-code-generator/code_ ### Générer un `Template` -By default, `code_generator_demo` generate itself, `code_generator_demo`. +By default, `code_generator_demo` generates itself, `code_generator_demo`. -Name your module begin with `MODULE_NAME = "code_generator_template_"` +Name your module beginning with `MODULE_NAME = "code_generator_template_"` The value "enable_template_code_generator_demo" at `False` to create a new template module, else this will recreate `code_generator_demo`. @@ -636,7 +636,7 @@ Par défaut, installer le module code_generator_demo va générer le module `cod Nommer votre module en commençant par `MODULE_NAME = "code_generator_template_"` -Example, to generate the module `code_generator_template_demo_website_snippet`, change value: +For example, to generate the module `code_generator_template_demo_website_snippet`, change value: Un exemple, générer le module `code_generator_template_demo_website_snippet`, changer la variable `value`: @@ -672,13 +672,13 @@ make addons_install_code_generator_demo ### Générer un Code_Generator (suite de template) -Name your module begin with `MODULE_NAME = "code_generator_"` +Name your module beginning with `MODULE_NAME = "code_generator_"` -Au besoin, renommé votre module qui débute par `MODULE_NAME = "code_generator_"` +Au besoin, renommer votre module qui débute par `MODULE_NAME = "code_generator_"` -Continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: +To continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: Pour continuer avec l'exemple, généré le template `code_generator_template_demo_website_snippet`, ceci va écraser `code_generator_demo_website_snippet`: @@ -705,12 +705,12 @@ Aller à la section [Créer votre premier module](#crer-votre-premier-module) TODO validate this -Name your module begin with `MODULE_NAME = "code_generator_demo_"` +Name your module beginning with `MODULE_NAME = "code_generator_demo_"` Disable `enable_template_code_generator_demo` -Nommé votre module qui débute par `MODULE_NAME = "code_generator_demo_"` +Nommer votre module qui débute par `MODULE_NAME = "code_generator_demo_"` Désactiver la variable `enable_template_code_generator_demo` @@ -720,10 +720,10 @@ value["enable_template_code_generator_demo"] = False ``` -Continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: +To continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: -Pour continuer avec l'exemple, généré le template `code_generator_template_demo_website_snippet`, ceci va écraser `code_generator_demo_website_snippet`: +Pour continuer avec l'exemple, générez le template `code_generator_template_demo_website_snippet`, ceci va écraser `code_generator_demo_website_snippet`: ```bash @@ -737,7 +737,7 @@ Pour continuer avec l'exemple, généré le template `code_generator_template_de ## Créer votre premier module -Continue example of code_generator_demo_website_snippet to generate your first module. Update next value: +To continue the example of code_generator_demo_website_snippet to generate your first module. Update next value: Continuer avec l'exemple du `code_generator_demo_website_snippet` pour générer votre premier module. Mettre à jour les valeurs suivantes : @@ -766,7 +766,7 @@ make db_restore_erplibre_base_db_code_generator ``` -Now, you can test it! Note, you cannot install a generated module with is code_generator associated, because duplicated +Now, you can test it! Note, you cannot install a generated module with his code_generator associated, because of duplicated models! @@ -801,7 +801,7 @@ value["template_model_name"] = "test;test2" TODO -Exécuter l'installation du template pour qu'il se synchronise sur le module généré. +Exécuter l'installation du template pour qu'il se synchronise avec le module généré. ```bash @@ -842,7 +842,7 @@ code_generator_writer.set_module_translator(new_module_name, new_module_path) ``` -First, install the module, example `demo_portal`, and after the template, example `code_generator_template_demo_portal`. +First, install the module, for example `demo_portal`, and after the template, for example `code_generator_template_demo_portal`. Premièrement, installer le module, par exemple `demo_portal`, et ensuite le template, par exemple `code_generator_template_demo_portal`. @@ -861,7 +861,7 @@ make db_restore_erplibre_base_db_code_generator # Synchroniser les champs du `Code_Generator` du module -This reduce time of programming a `Code_Generator` with sync module field with `Template`. +This reduce the time it takes for programming a `Code_Generator` with sync module field with `Template`. You need a `Template`, a `Code_Generator` with his `Module`. Install the `Module` first in clean database and install `Template`, this will generate the `Code_Generator`, use `enable_sync_template` at True. @@ -871,7 +871,7 @@ Example: Ceci va permettre de réduire le temps de programmation d'un `Code_Generator` avec la synchronisation des champs de module avec `Template`. -On a besoin d'un `Template`, un `Code_Generator` accompagné de son module. Installer le module en premier dans une base de donnée nettoyé et installer le `Template`, ceci va générer le `Code_Generator`, utiliser `enable_sync_template` à la valeur `True`. +On a besoin d'un `Template`, un `Code_Generator` accompagné de son module. Installer le module en premier dans une base de données nettoyée et installer le `Template`, ceci va générer le `Code_Generator`, utiliser `enable_sync_template` à la valeur `True`. Exemple : @@ -914,7 +914,7 @@ make test_code_generator_generation TODO -Tester les générations extra : +Tester les générations extras : ```bash diff --git a/doc/DEVELOPMENT.md b/doc/DEVELOPMENT.md index 74c07fc..f470f50 100644 --- a/doc/DEVELOPMENT.md +++ b/doc/DEVELOPMENT.md @@ -24,7 +24,7 @@ You need to remove `clone-depth="10"` from `./manifest/default.dev.xml` in order Make a temporary commit and regenerate with `./script/install_locally_dev.sh` ## Fork project to create a new project independent from ERPLibre (deprecated) -ERPLibre was created by this script. It's now deprecated. +ERPLibre was created with this script. It's now deprecated. Use this script when you need to fork directly from the original source. Don't use this script if you want to update from ERPLibre and follow mainstream development. ```bash @@ -32,9 +32,9 @@ Don't use this script if you want to update from ERPLibre and follow mainstream ``` # Fork all repos for you own organization -Go to your github account and generate a token to access fork option with your user. Create an organization or use your personal account can choose your user name. +Go to your Github account and generate a token to access fork option with your user. Create an organization or use your personal account and choose your user name. -This command will fork all repos and ERPLibre to your own organization. It keeps track to ERPLibre. +This command will fork all repos and ERPLibre to your own organization. It keeps track of ERPLibre. ```bash ./script/fork_project_ERPLibre.py --github_token GITHUB_KEY --organization NAME ``` @@ -47,15 +47,15 @@ Execute to generate Repo manifest ./script/fork_project_ERPLibre.py --skip_fork ``` -## Move database prod to dev -When moving database prod to your dev environment, you want to remove email servers and install user test in order to test the database. +## Move database from prod to dev +When moving database from prod to your dev environment, you want to remove email servers and install user test in order to test the database. Run: ```bash ./run.sh --stop-after-init -i user_test,disable_mail_server --dev all -d DATABASE ``` -## Change git url https to git -This will update all urls in git format: +## Change git url https to Git +This will update all urls in Git format: ```bash ./script/git_change_remote_https_to_git.py ``` @@ -67,7 +67,7 @@ Tools to display the differences between the repo and another project. ``` ## Showing repo differences with manifest develop -To understand the divergence with the dev manifest. +To understand the divergences with the dev manifest. ```bash ./script/git_show_code_diff_repo_manifest.py -m ./manifest/default.dev.xml ``` diff --git a/doc/GIT_REPO.md b/doc/GIT_REPO.md index 05e9254..d5d5a4c 100644 --- a/doc/GIT_REPO.md +++ b/doc/GIT_REPO.md @@ -30,12 +30,12 @@ git daemon --base-path=. --export-all --reuseaddr --informative-errors --verbose ``` # Create Manifest -A [Manifest](https://gerrit.googlesource.com/git-repo/+/master/docs/manifest-format.md), is a XML file managed by git-repo to generate repo. +A [Manifest](https://gerrit.googlesource.com/git-repo/+/master/docs/manifest-format.md), is an XML file managed by git-repo to generate a repo. ## Make a new version of prod It freezes all repo, from dev to prod. -This will add revision git hash in the Manifest. +This will add revision git hash in the manifest. ```bash ./.venv/repo manifest -r -o ./default.xml ``` @@ -66,7 +66,7 @@ git commit -am "[#ticket] subject: short sentence" ``` ## Useful commands -### Search all repo with a specific branch name +### Search all repos with a specific branch name ```bash ./.venv/repo forall -pc "git branch -a|grep BRANCH" ``` @@ -82,7 +82,7 @@ git commit -am "[#ticket] subject: short sentence" ``` ### Clean all -Before, check changed file in all repos. +Before cleaning, check changed file in all repos. ```bash ./.venv/repo forall -pc "git status -s" @@ -97,4 +97,4 @@ Check the changed branch, and push changed if needed. Maybe, some version diverge from your manifest. Simply clean all and relaunch your installation. ```bash ./script/clean_repo_manifest.sh -``` \ No newline at end of file +``` diff --git a/doc/POETRY.md b/doc/POETRY.md index df94ae7..5ed5658 100644 --- a/doc/POETRY.md +++ b/doc/POETRY.md @@ -1,5 +1,5 @@ # Poetry -## Add automatically dependencies +## Add dependencies automatically Add your dependencies in file [requirements.txt](../requirements.txt) and run script ```bash ./script/poetry_update.py @@ -10,7 +10,7 @@ Priority dependencies in ./requirements.txt, after it's ./odoo/requirements.txt, TODO add option to only add missing dependencies and ignore update. -## Add manually dependencies +## Add dependencies manually The automatic script will erase this dependency, but you can add it for your local test. ```bash poetry add PYTHON_MODULE diff --git a/doc/PRODUCTION.md b/doc/PRODUCTION.md index 588b596..5fe2558 100644 --- a/doc/PRODUCTION.md +++ b/doc/PRODUCTION.md @@ -16,7 +16,7 @@ Modify the file env_var.sh for production installation. Enable nginx if you need a proxy with `EL_INSTALL_NGINX`. Redirect your DNS to the proxy's ip and add your A and AAAA into `WL_WEBSITE_NAME` with space between. -### 3. Execute the script: +### 3. Execute the scripts: #### With proxy nginx production, install certbot before for SSL ```bash @@ -37,7 +37,7 @@ sudo ln -s /snap/bin/certbot /usr/bin/certbot ./script/install_dev.sh ./script/install_production.sh ``` -A service is running by SystemD. You can access it with the DNS name found in env_var.sh +A service is runned by SystemD. You can access it with the DNS name found in `env_var.sh` #### Ubuntu 20.04 server Apply fix libpng12-0: https://www.linuxuprising.com/2018/05/fix-libpng12-0-missing-in-ubuntu-1804.html @@ -46,7 +46,7 @@ Apply fix libpng12-0: https://www.linuxuprising.com/2018/05/fix-libpng12-0-missi ./script/install_dev.sh ./script/install_production.sh ``` -A service is running by SystemD, you can access with the DNS name found in env_var.sh +A service is runned by SystemD, you can access it with the DNS name found in `env_var.sh` ### 4. SSL: Generate a ssl certificate @@ -82,7 +82,7 @@ cd /[EL_USER]/erplibre ## Move prod database to dev When moving prod database to your dev environment, you want to remove email servers and install user test to test the database. -Warning, this is not safe for production, you expose all data. +WARNING, this is not safe for production, you will expose all data. Run: ```bash ./script/migrate_prod_to_test.sh DATABASE @@ -95,14 +95,14 @@ Update all features. ``` # Postgresql -To show config file: +To show config files: > psql -U postgres -c 'SHOW config_file' Edit this file to accept interface from all networks: > /var/lib/postgres/data/postgresql.conf # Delete an instance in production -Caution, this delete user's home, it's irrevocable. +CAUTION, this will delete user's home, it's irrevocable. ```bash ./script/delete_production.sh ``` @@ -130,4 +130,4 @@ vim /etc/crontab Check log with ```bash sudo journalctl -feu cron -``` \ No newline at end of file +``` diff --git a/doc/RELEASE.md b/doc/RELEASE.md index 0aaa6f9..7439278 100644 --- a/doc/RELEASE.md +++ b/doc/RELEASE.md @@ -2,16 +2,16 @@ A guide on how to generate a release. -## Clean environment before generate new release +## Clean environment before generating new release -Before clean, check if existing file not committed, not pushed or in stash. +Before the cleaning, check if existing file is not committed, not pushed or in stash. ```bash ./.venv/repo forall -pc "git stash list" ./script/git_show_code_diff_repo_manifest.py ``` -This will erase everything in addons. Useful before create docker, manifest and do a release. +This will erase everything in addons. Useful before creating docker, manifest and do a release. ```bash ./script/clean_repo_manifest.sh @@ -25,12 +25,12 @@ And update all from dev to merge into prod. ## Validate environment -- Check [manifest/default.dev.xml](../manifest/default.dev.xml) is ready for production. +- Check if [manifest/default.dev.xml](../manifest/default.dev.xml) is ready for production. - Run test with `make test` ### Update image_db -Run `make image_db_create_all`, this will generate image in directory `./image_db`. +Run `make image_db_create_all`, this will generate an image in directory `./image_db`. ### Test docker generate @@ -101,7 +101,7 @@ Review by your peers, test the docker file and merge to master. ## Generate image db to accelerate db installation -Generate image db before tag, the image is store in directory ./image_db +Generate image db before tag, the image is stored in directory ./image_db ```bash make image_db_create_all @@ -148,4 +148,5 @@ To generate a list of differences between repo git commit ```bash ./script/git_change_remote.py --sync_to /path/to/directory -``` \ No newline at end of file +``` +