From 8e823b78abecd590e382e7cdd434d4e2300b22af Mon Sep 17 00:00:00 2001 From: Plumf Date: Mon, 30 Mar 2020 14:24:59 +0200 Subject: [PATCH 01/63] Adding pages & adding properties in the menu --- contributordoc_fr.md | 3 +++ doc_markdown_guide.md | 1 + doc_markdown_guide_fr.md | 1 + doc_use_git.md | 1 + doc_use_git_fr.md | 1 + doc_writing_guide.md | 1 + doc_writing_guide_fr.md | 1 + 7 files changed, 9 insertions(+) create mode 100644 doc_markdown_guide.md create mode 100644 doc_markdown_guide_fr.md create mode 100644 doc_use_git.md create mode 100644 doc_use_git_fr.md create mode 100644 doc_writing_guide.md create mode 100644 doc_writing_guide_fr.md diff --git a/contributordoc_fr.md b/contributordoc_fr.md index 57ad494d..9e786a76 100644 --- a/contributordoc_fr.md +++ b/contributordoc_fr.md @@ -2,6 +2,9 @@ * [Liste des façons de contribuer à YunoHost](/contribute) * [Écrire de la documentation](/write_documentation) + * [Guide de redaction de la documentation](dc_writing_guide_fr) + * [Guide markdown](/doc_markdown_guide_fr) + * [Propulser son code avec git & github](/doc_use_git_fr) * [Salons de discussion](/chat_rooms) * Packaging d'application * [Liste d'apps souhaitées par la communauté](/apps_wishlist) diff --git a/doc_markdown_guide.md b/doc_markdown_guide.md new file mode 100644 index 00000000..9fac816d --- /dev/null +++ b/doc_markdown_guide.md @@ -0,0 +1 @@ +# Markdown Guide diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md new file mode 100644 index 00000000..dadfab54 --- /dev/null +++ b/doc_markdown_guide_fr.md @@ -0,0 +1 @@ +# Guide Markdown diff --git a/doc_use_git.md b/doc_use_git.md new file mode 100644 index 00000000..fe2378d3 --- /dev/null +++ b/doc_use_git.md @@ -0,0 +1 @@ +# Propel your contribution with git diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md new file mode 100644 index 00000000..d35b179d --- /dev/null +++ b/doc_use_git_fr.md @@ -0,0 +1 @@ +# Propulser une contribution avec git diff --git a/doc_writing_guide.md b/doc_writing_guide.md new file mode 100644 index 00000000..699f4ce2 --- /dev/null +++ b/doc_writing_guide.md @@ -0,0 +1 @@ +# Guide to writing documentation diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md new file mode 100644 index 00000000..9552b945 --- /dev/null +++ b/doc_writing_guide_fr.md @@ -0,0 +1 @@ +# Guide de rédaction de la documentation des apps From e4d94d8d80f8d515e1001f992753cba03c1e742e Mon Sep 17 00:00:00 2001 From: Plumf Date: Mon, 30 Mar 2020 18:59:16 +0200 Subject: [PATCH 02/63] Add writing guide, git guide and markdown guide fr version final --- doc_markdown_guide_fr.md | 256 +++++++++++++++++++++++++++++++++++++++ doc_use_git_fr.md | 64 ++++++++++ doc_writing_guide_fr.md | 62 ++++++++++ 3 files changed, 382 insertions(+) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index dadfab54..1460bd59 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -1 +1,257 @@ # Guide Markdown + +**Index** + - [Les différents niveaux de titres](#NiveauxTitres) + - [Formatage dans les paragraphes](#FormatageParagraphe) + - [Créer des liens](#CreerLiens) + + [Créer des ancres](#LiensAncres) + - [Afficher des images](#AfficherImages) + - [Formater une citation](#FormaterCitation) + - [Les listes](#UtiliserListes) + + [Listes ordonnées](#ListesOrdonnees) + + [Listes non ordonnées](#ListesNonOrdonnees) + - [Les tableaux](#UtiliserTableaux) + - [Bloc de Codes](#BlockCodes) + +Le Markdown est un langage de balisage créé en 2004, de nombreux add-on développant les possibilités de ce langage existent. L'objectif de ce guide est de tendre vers l'exaustivité des possibilités de ce langage de formatage dans le cadre de la documentation de Yunohost et non du langage Markdown en général. + +Markdown permet de formater du texte à l'aide de balises, il permet une lecture *humaine* du texte ; même avec le formatage. Même si un unique bloc note est nécessaire il existe de nombreux logiciels markdowns (Markdown sur [framalibre.org](https://framalibre.org/recherche-par-crit-res?keys=markdown)). Sa prise en main est relativement facile. + +## Les différents niveaux de titres + +En rédigeant des titres comme suit : +```markdown +# Titre de niveau 1 +## Titre de niveau 2 +### Titre de niveau 3 +#### Titre de niveau 4 +##### Titre de niveau 5 +###### Titre de niveau 6 +``` + +Ils apparaissent comme cela : +# Titre de niveau 1 +## Titre de niveau 2 +### Titre de niveau 3 +#### Titre de niveau 4 +##### Titre de niveau 5 +###### Titre de niveau 6 + +## Formatage dans les paragraphes + +Pour taper un retour à la ligne sans créer de nouveau paragraphe, il est nécessaire de taper **deux espaces consécutifs**.Sans cela, le texte continuera à la suite en respectant les contraintes générales du style de la page. + +En rédigeant ça : + +```markdown +Pour du texte en *italique il faut encadrer par un astérique`*`* +Pour rédiger du **texte en gras par deux astériques** +On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` +``` + +On peut lire ça : + +Pour du texte en *italique il faut encadrer par un astérique `*` * +Pour rédiger du **texte en gras par deux astériques** +On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` + +## Créer des liens + +Pour créer un lien vers un site hors de la documentation de Yunohost : + +```markdown +[Texte à afficher](https://lelien.tld) +``` + +s'affichera comme tel : +[Texte à afficher](https://lelien.tld) + +C'est identique pour les pages de la documentation, excepté que le lien est interne. Il renvoie au fichier du wiki, sans extension de fichier (le `.md`) : +``` +[Page du wiki](write_documentation_fr) +``` +[Page du wiki](write_documentation) + +### Créer des ancres +Une ancre permet de faire un lien vers un point précis dans une page, c'est comme ça que fonctionnent les index en haut de page. Pour créer une ancre, il faut insérer du code à l'endroit de l'ancre sous la forme suivante : + +``` +Du texte qui sera ne sait même pas qu'il a une ancre +``` + +Ce qui s'affiche : +Du texte qui sera ne sait même pas qu'il a une ancre + +Il ne reste plus qu'à désigner l'ancre au texte que l'on souhaite rendre interactif : + +``` +[Mon titre qui renvoie](#NomDeLAncre) +``` + +[Mon titre qui renvoie](#NomDeLAncre) + +## Afficher des images + +Pour afficher des images, le principe est identique aux liens, excepté l'ajout d'un `!` avant le texte à afficher qui est ici considéré comme le texte à afficher en cas d'impossibilité de chargement de l'image. Une description de l'image convient. + +``` +![Logo Yunohost](/images/logo.png) +``` +![Logo Yunohost](/images/logo.png) + +Il est possible de faire un lien avec une image, exemple : +``` +[![Logo Yunohost](/images/logo.png)](write_documentation) +``` +[![Logo Yunohost](/images/logo.png)](write_documentation) + +L'encart de *texte à afficher en cas d'impossibilité de chargement de l'image* n'est pas obligatoire mais fortement recommandé. + +## Formater une citation + +Les citations permettent de mettre en valeur un propos tenu par une autre personne, le wiki gère lui même la façon dont c'est valorisé. Markdown utilise un chevron fermant, ce symbole : `>`, pour annoncer une citation. Il suffit de les rajouter avant la citation, comme tel : +``` +>Du texte de citation du premier niveau +>qui peut être formaté en différentes lignes + +>> Et une seconde citation +>> avec des doubles chevrons +``` +S'affichera : + +>Du texte de citation du premier niveau +>qui peut être formaté en différentes lignes + +>> Et une seconde citation +>> avec des doubles chevrons + +## Les listes + +Les listes permettent d'afficher une suite de textes dans une présentation facile, c'est ainsi que sont rédiger les index tels que celui de la page de la [documentation contributeur](contributordoc). + +### Listes ordonnées + +Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'est pas obligé de donner la bonne correspondance au nombre. Il est possible de noter avec des `1.` comme des `7.` et installer trois espaces pour marquer l'incrémentation. Pour une meilleure compréhension du texte brut, il peut être bien d'utiliser les chiffres de manières croissantes pour marquer l'incrémentation, mais c'est bien les trois `espaces` conséquents avant la sous-liste qui désigneront l'incrémentation. + +``` +1. Liste 1 +1. Liste 2 +1. liste 3 + 1. Liste 3a + 1. Liste 3b + 3. Liste 3b1 + 3. Liste 3b2 + 3. Liste 3b3 + 4. Liste 1 + 4. Liste 2 + 4. liste 3 +1. Liste 4 +1. Liste 5 +1. liste 6 +``` + +On obtient : + +1. Liste 1 +1. Liste 2 +1. liste 3 + 1. Liste 3a + 1. Liste 3b + 3. Liste 3b1 + 3. Liste 3b2 + 3. Liste 3b3 + 4. Liste 1 + 4. Liste 2 + 4. liste 3 +5. Liste 4 +3. Liste 5 +4. liste 6 + +### Listes non ordonnées + +Pour créer une liste non ordonnée, il faut utiliser les symboles `*`, `+` ou `*`. Cela ne changera pas l'apparence du marqueur dans la restitution du texte. C'est l'incrémentation de la liste qui définira le visuel. Pour une meilleure lecture du texte brut, il peut être bien d'utiliser les différents symboles pour marquer l'incrémentation, mais c'est bien les trois espaces avant la sous-liste qui désigneront l'incrémentation. +Comme tel : +``` ++ Liste 1 ++ Liste 2 ++ liste 3 + - Liste 3a + - Liste 3b + * Liste 3b1 + * Liste 3b2 + * Liste 3b3 + + Liste 1 + + Liste 2 + + liste 3 +- Liste 4 +* Liste 5 ++ liste 6 +``` + +Ce qui affichera : ++ Liste 1 ++ Liste 2 ++ liste 3 + - Liste 3a + - Liste 3b + * Liste 3b1 + * Liste 3b2 + * Liste 3b3 + + Liste 1 + + Liste 2 + + liste 3 +- Liste 4 +* Liste 5 ++ liste 6 + +## Les tableaux + +Pour créer un tableau, il faut utiliser la barre verticale `|` et les tirets `-`. Il est obligatoire d'ajouter une ligne de tiret sous la première ligne du tableau. Il n'y a aucune contrainte dans la taille de ce dernier. Il est possible de formater le tableau avec les `:` dans la seconde ligne du tableau, trois options s'offrent à vous : + +| Colonne alignée à gauche | Colonne centrée | Colonne alignée à droite | +|:-------------------------|:---------------:|-------------------------:| +|`:-----` | `:----:` | `-----:` | + +``` +| **Un tableau** | Une colonne | Une seconde | Autant que l'on veut | +|:--------------:|:-----------:|:-----------:|:--------------------:| +| Une ligne formatée | | Et du **texte en gras** | Ou en *italique* | +| D'autres lignes | |![une image](/images/cd.jpg) | [Ou un lien]( contributordoc) | +``` +Ce qui afficherait ça : + +| **Un tableau** | Une colonne | Une seconde | Autant que l'on veut | +|:--------------:|:-----------:|:-----------:|:--------------------:| +| Une ligne formatée | | Et du **texte en gras** | Ou en *italique* | +| D'autres lignes | |![une image](/images/cd.jpg) | [Ou un lien]( contributordoc) | + +## Bloc de codes + +Pour afficher du texte en brut, des `blocs de codes` peuvent être créer : + +```` +Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` +``` +ou directement en bloc. +La seule différence est dans la quantité de : ` +Minimum ``` en ouverture et fermeture de bloc et deux ` qui encadre le morceau de texte à formater dans une ligne +``` +```` + +Ce qui donnera au rendu : + +Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` +``` +ou directement en bloc. +La seule différence est dans la quantité de : ` +Minimum ``` en ouverture et fermeture de bloc et deux ` qui encadre le morceau de texte à formater dans une ligne +``` + +## Liens utiles + + + La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) + + Tutoriel Markdown sur [markdowntutorial.com (en)](https://markdowntutorial.com) + +## Aller plus loin + +De manière plus général, pour comprendre comment est formaté un texte il suffit juste d'inspecter le document source avec une application note. Ce n'est pas pour autant que le wiki de YunoHost pourra l'exploiter. Il existe bien d'autres possibilités d'utiliser la syntaxe markdown, n'hésitez pas à ajouter des fonctionnalités manquantes. Si vous avez observé des manques et/ou que vous avez des questions, contactez-nous sur [le forum](https://forum.yunohost.org) ou par message directe sur le salon IRC : **#yunohost** sur [irc.freenode.net](https://irc.freenode.net). diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index d35b179d..30913d8c 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -1 +1,65 @@ # Propulser une contribution avec git + +**Index** + - [Création d'un compte sur github.com](#CreationCompteGithub) + - [Forker la documentation de YunoHost dans votre dépôt personnel](#ForkerDocumentationYunoHost) + - [Modifier les fichiers et ajouter vos contributions](#ModifAjoutContrib) + - [Envoyer vos contributions avec une Pull Request](#EnvoyerPR) + - [Suivre votre contribution et prendre en compte les retours des contributeurs·trices](#SuivreContributions) + - [Faire remonter des erreurs et des souhaits en créant une issue](#RemonterIssues) + - [Corriger et inspecter les contributions](#ReviewContrib) + - [Aller plus loin avec git et travailler en local sur son ordinateur](#PlusLoinGitOrdi) + - [Quelques ressources sur le web](#LiensWeb) + +Il est bien sûr possible de contribuer directement sur la documentation de Yunohost, mais ce n'est pas la manière la plus pratique de le faire tant pour le/la contributeur·trice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de Yunohost en utilisant l'outil [git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge git qui héberge et stocke le code source de Yunohost ainsi que sa documentation. + +## Création d'un compte sur github.com +Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur github, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. Github est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. +Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utiliser un pseudonyme (lors de l'inscription `Username`). + +*/iframe video creer compte github /* + + +## Forker la documentation de YunoHost dans votre dépôt personel +Forker le code source permet de créer une nouvelle branche de développement d'un code source de logiciel ou dans le cas présent, le code source de la documentation. En créant une nouvelle branche, cela vous permet de modifier le code et d'ajouter vos contributions sans altérer le code de la branche `master` qui est le rendu public de la documentation. Ce qui vous permet de ne pas devoir tout marquer mais le faire en plusieurs étapes. (Notamment pour les contributions demandant plus de temps de travail). + +Forker un projet sur github est extrêmement simple, il suffit ce cliquer sur le bouton Fork, cela créera un nouveau dépôt sur votre espace de github. +![Capture d'écran bouton fork github](/images/dug_fork.png) +Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dépôt, dans le cas présent `YunoHost/doc` +![Capture d'écran titre et sous-titre du dépot](/images/dug_fork_source.png) + +*/iframe video forker code source github /* + + +> **Point de vigilance !** +> Si vous forkez le dépôt d'un autre contributeur que yunohost, vous aurez les mêmes fichiers. Sauf que quand vous enverrez vos modifications, elles seront envoyées au contributeur et non au dépôt yunohost. L'avantage est que ça vous permet de développer une autre branche créee par le contributeur et ainsi travailler avec une autre personne à une amélioration avant proposition au dépôt principal. +> Il n'est pas possible d'avoir un fork du dépot d'un contributeur et le fork dépôt d'origine au même moment dans votre propre dépôt. + +## Modifier et ajouter votre contribution +Une fois le dépôt forker (copié), il faudra créer une nouvelle branche de développement au sein de votre dépôt. C'est à travers cette branche que vous allez modifier les fichiers et ainsi proposer des améliorations de la documentation. Le fait que ce soit une nouvelle branche vous permettra par la suite de faire une Pull Request, c'est à dire une demande d'ajout de vos contributions au sein de la branche `master` qui est la branche principale de la documentation. Les règles de développement sur github change selon les développeurs de chaque dépôt, certains ont une branche testing dans laquelle il faut proposer les contributions. +Plus d'informations sur qu'est une branche sur git-scm.com : [Les branches avec Git - Ce qu'est une branche](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). + +*/iframe video modifier fichiers ajouter contribution /* + +## Envoyer votre contribution par une Pull Request +Faire une Pull Request correspond au moment ou vous souahitez partager votre travaille avec le reste des contributeurs⋅trices et l'intégrer au dépot master (dépôt principale de Yunohost). Lors de la publication d'un Pull Request, couramment nommé PR, les contributeurs⋅trices pourront amender, commenter, ajouter, corriger votre contribution avant intégration complète au dépot. + +## Suivre votre contribution et prendre en compte les retours des contributeurs·trices +Lorsque vous avez déjà fait une PR (Pull Request), les modifications de votre branche de développement sur le dépôt git se rajouteront automatiquement à la PR. Cela ne nécessite aucune action supplémentaire. Vous pouvez aussi intégrer les propositions de modifications de contributeurs, qui lorsqu'ils/elles auditeront le code, peuvent trouver des erreurs ou de nouvelles formulations plus adaptées. + +## Faire remonter des erreurs et des souhaits par des issues +YunoHost dispose d'un dépôt git spécifique pour le recueil des issues : [github.com/YunoHost/issues](https://github.com/YunoHost/issues) +Une issue aussi appelé ticket, est un problème identifié ou alors un souhait de développement ; dans le cas présent pour la documentation, mais c'est valable pour tout dépôt logiciel. Dans le cadre de la documentation de YunoHost il sera surtout proposé des issues pour le développement de la documentation, les problèmes identifiés étant facilement corrigeable. + +## Aller plus loin avec git et travailler sur son poste de travail +Utiliser la puissance de git et ainsi travailler sur son ordinateur personnel, permet entre autres de ne pas avoir à créer de `commit` à chaque enregistrement intermédiaire des pages de documentations modifiées. Cela permet aussi d'utiliser des outils et logiciels qui permettent une distinction plus facile des codes utilisés dans une page de documentation. + +- Ressource en ligne : [docs.microsoft.com - Configurer un référentiel Git localement pour la documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) + +## Quelques ressources ailleurs sur le net pour aller plus loin + - [Gérer son code avec git et github - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) + - [Interface utilisateurs·trices de git - git-scm.com](https://git-scm.com/download/gui/linux) + +*/ To do/* +*/Ajouter vidéos explicative - Add videos explication/* +*/Ajouter ## Corriger et inspecter les contributions /* diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index 9552b945..4a03a54e 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -1 +1,63 @@ # Guide de rédaction de la documentation des apps + +## Pages de documentations utilisateurs.trices / administrateurs⋅trices + +Ajouter un bouton installer en un clique (comme par exemple : https://yunohost.org/#/app_piwigo_fr) + +Classement des applications disponibles par tags (genre, Git, gestion associations, courriels, etc.). + +*/Définition d'une license de diffusion de la documentation, mais laquelle ? Permissive ou non (CC By-Sa)/* + +## Quelques usages types et d'ordres général (trame de rédaction) + + + Lorsqu'un lien renvoi vers une page qui n'est pas dans la langue de la page d'origine, il est d'usage d'ajouter `(en)`(Pour un lien qui pointe vers une page en anglais). + +### Trame général documentation applications + + 1. Un index en tête de documentations avec renvois vers l'ensemble des chapitres de la documentation. + 1. Bouton installer en un clique. + 1. Une présentation général de l'application et de sa fonction. + 1. Une partie administration de l'application. + 1. Une partie aller plus loin, Manipulations techniques liés spécifiquement à Yunohost. + 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des apps officiels sont fournis. + + Une partie avec : + - les liens vers le site officiel + - Les liens vers le package de yunohost + 1. Documentation de l'utilisation si besoin (cf. Documenter une application). + +## Feuille de route + +1. Documenter les applications. + 1. Documenter les applications au travail (marqué : work) niveau 8/7/6. + 1. Traduire la page de documentation à minima en français et en anglais. + 1. Faire une PR sur le dépot de l'app concerné vers la page de documentation. + +## Documenter une application + +Faut-il documenter son utilisation ? + +``` +La documentation de l'application est elle disponible en français & en anglais ? + / \ + / \ + / \ + / \ + / \ + ------- ------- + | Oui | | Non |----> Documenter l'application <----<----<----<----- + ------- ------- dans la documentation de YunoHost | + | | + La documentation utilisateur est elle de bonne qualité et suffisante ? | + / \ | + / \ | + / \ | + / \ | + / \ | + ------- ------- | + Renvoi dans la page de doc ------- | Oui | | Non |---->---->---->---->---->---->---->---->---->---->---->---->---->- +YunoHost vers le site officiel ------- ------- +``` + +## Potentielles problématiques rencontrés ? + +Quid des apps qui sont des containers à d'autres applications, tel que Nextcloud et qui présentes de multiples possibilités d'usages. From 7d699f1279d7cd31b05766eecfe88dd2a00b316f Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Tue, 31 Mar 2020 10:55:57 +0200 Subject: [PATCH 03/63] Update doc_writing_guide.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/doc_writing_guide.md b/doc_writing_guide.md index 699f4ce2..ec2e62da 100644 --- a/doc_writing_guide.md +++ b/doc_writing_guide.md @@ -1 +1,37 @@ -# Guide to writing documentation +# Guide to writing application documentation + +## Pages for user / administative documentation + +Add a one-click installation button (like for example: https://yunohost.org/#/app_piwigo) + +Classification of the application can be done using the available tags (genre, Git, management association, e-mails, etc.) + +*/Find a suitable documentation license. Permissive or not? (CC BY_SA)/* + +## Clarify the types of uses it has (special and general application (editorial choice) + + + For links to other languages, add (en)` for Egnlish, and so on. + +### Things to include in application documentation + + 1. An index of what is included, without reiterating the full content of what is to be found in subsequent chapters. + 1. A one-click install button. + 1. A general presentation of the application and its function. + 1. A section detailing administration of the application. + 1. A further section on changes specific to YunoHost. + 1. A section about the desktop client (if applicable). Links to different third party applications (if they exist), (or a link to a list of applications [framalibre.org](https://framalibre.org)) or a link to a page that has to do with the different official applications (if applicable). + + A further section: + - Links to the official website. + - Links to the package in YunoHost. + 1. Documentation of any further uses (documentation of an application). + +## Roadmap + +1. Documentation of the applications. + 1. Document how the application operates in use (marked: work) level 8/7/6. + 1. Translate the documentation at-least into French and English. + 1. Send a PR to the repository of the app that details its documentation. + +## Document an application + +Do you need to detail how it works? From 4f6e6ac4959fff412fc779fdb421bf944d165113 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Tue, 31 Mar 2020 10:56:12 +0200 Subject: [PATCH 04/63] Update doc_writing_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index 4a03a54e..4b319e91 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -22,7 +22,7 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des apps officiels sont fournis. + Une partie avec : - les liens vers le site officiel - - Les liens vers le package de yunohost + - Les liens vers le package de YunoHost 1. Documentation de l'utilisation si besoin (cf. Documenter une application). ## Feuille de route From 02315d91608af603e936ef070aaba451115d58a0 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Tue, 31 Mar 2020 10:57:38 +0200 Subject: [PATCH 05/63] Update contributordoc_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- contributordoc_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributordoc_fr.md b/contributordoc_fr.md index 9e786a76..ab1aef6a 100644 --- a/contributordoc_fr.md +++ b/contributordoc_fr.md @@ -4,7 +4,7 @@ * [Écrire de la documentation](/write_documentation) * [Guide de redaction de la documentation](dc_writing_guide_fr) * [Guide markdown](/doc_markdown_guide_fr) - * [Propulser son code avec git & github](/doc_use_git_fr) + * [Propulser son code avec Git & GitHub](/doc_use_git_fr) * [Salons de discussion](/chat_rooms) * Packaging d'application * [Liste d'apps souhaitées par la communauté](/apps_wishlist) From ae333dd1f7eecbffb541a71d15391272c2055ad5 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Tue, 31 Mar 2020 10:58:06 +0200 Subject: [PATCH 06/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 30913d8c..cc2dd952 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -8,7 +8,7 @@ - [Suivre votre contribution et prendre en compte les retours des contributeurs·trices](#SuivreContributions) - [Faire remonter des erreurs et des souhaits en créant une issue](#RemonterIssues) - [Corriger et inspecter les contributions](#ReviewContrib) - - [Aller plus loin avec git et travailler en local sur son ordinateur](#PlusLoinGitOrdi) + - [Aller plus loin avec Git et travailler en local sur son ordinateur](#PlusLoinGitOrdi) - [Quelques ressources sur le web](#LiensWeb) Il est bien sûr possible de contribuer directement sur la documentation de Yunohost, mais ce n'est pas la manière la plus pratique de le faire tant pour le/la contributeur·trice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de Yunohost en utilisant l'outil [git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge git qui héberge et stocke le code source de Yunohost ainsi que sa documentation. From f45292ac24bb2855594baa2059584f4ba1878942 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Tue, 31 Mar 2020 11:02:30 +0200 Subject: [PATCH 07/63] Update doc_writing_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index 4b319e91..193b8538 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -18,7 +18,7 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio 1. Bouton installer en un clique. 1. Une présentation général de l'application et de sa fonction. 1. Une partie administration de l'application. - 1. Une partie aller plus loin, Manipulations techniques liés spécifiquement à Yunohost. + 1. Une partie aller plus loin, Manipulations techniques liés spécifiquement à YunoHost. 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des apps officiels sont fournis. + Une partie avec : - les liens vers le site officiel From 083d694b359a21515bf569adf99f6afec5a3fd3e Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Tue, 31 Mar 2020 11:02:46 +0200 Subject: [PATCH 08/63] Update doc_markdown_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 1460bd59..bc2e2e86 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -57,7 +57,7 @@ On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` ## Créer des liens -Pour créer un lien vers un site hors de la documentation de Yunohost : +Pour créer un lien vers un site hors de la documentation de YunoHost : ```markdown [Texte à afficher](https://lelien.tld) From b716e6d4ba0e479a12a88acfb920e449b45261d1 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:07:20 +0200 Subject: [PATCH 09/63] Update doc_writing_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index 193b8538..92f20f88 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -6,7 +6,7 @@ Ajouter un bouton installer en un clique (comme par exemple : https://yunohost.o Classement des applications disponibles par tags (genre, Git, gestion associations, courriels, etc.). -*/Définition d'une license de diffusion de la documentation, mais laquelle ? Permissive ou non (CC By-Sa)/* +*/Définition d'une license de diffusion de la documentation, mais laquelle ? Permissive ou non (CC BY-SA)/* ## Quelques usages types et d'ordres général (trame de rédaction) From d9c4b1bce69f8628926eecb3a2fe5a7392147a3b Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:07:33 +0200 Subject: [PATCH 10/63] Update doc_markdown_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index bc2e2e86..0d71f6db 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -234,7 +234,7 @@ Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` ``` ou directement en bloc. La seule différence est dans la quantité de : ` -Minimum ``` en ouverture et fermeture de bloc et deux ` qui encadre le morceau de texte à formater dans une ligne +Minimum ``` en ouverture et fermeture de bloc et deux ` qui encadre le morceau de texte à formater dans une ligne ``` ```` From f7363353b4a87cf9f0e2d1a3de898a4ddfb445dc Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:07:51 +0200 Subject: [PATCH 11/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index cc2dd952..fc09ab51 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -11,7 +11,7 @@ - [Aller plus loin avec Git et travailler en local sur son ordinateur](#PlusLoinGitOrdi) - [Quelques ressources sur le web](#LiensWeb) -Il est bien sûr possible de contribuer directement sur la documentation de Yunohost, mais ce n'est pas la manière la plus pratique de le faire tant pour le/la contributeur·trice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de Yunohost en utilisant l'outil [git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge git qui héberge et stocke le code source de Yunohost ainsi que sa documentation. +Il est bien sûr possible de contribuer directement sur la documentation de YunoHost, mais ce n'est pas la manière la plus pratique de le faire tant pour le/la contributeur·trice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de Yunohost en utilisant l'outil [Git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge Git qui héberge et stocke le code source de YunoHost ainsi que sa documentation. ## Création d'un compte sur github.com Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur github, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. Github est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. From ee16cef44442a196a8645fc8d7055455a4830d4a Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:08:04 +0200 Subject: [PATCH 12/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index fc09ab51..d6a40f96 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -14,7 +14,7 @@ Il est bien sûr possible de contribuer directement sur la documentation de YunoHost, mais ce n'est pas la manière la plus pratique de le faire tant pour le/la contributeur·trice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de Yunohost en utilisant l'outil [Git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge Git qui héberge et stocke le code source de YunoHost ainsi que sa documentation. ## Création d'un compte sur github.com -Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur github, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. Github est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. +Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur GitHub, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. GitHub est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utiliser un pseudonyme (lors de l'inscription `Username`). */iframe video creer compte github /* From b8beff25385f5f3de945055e93a2fe62f1609db7 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:08:17 +0200 Subject: [PATCH 13/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index d6a40f96..1b19372f 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -23,7 +23,7 @@ Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utilis ## Forker la documentation de YunoHost dans votre dépôt personel Forker le code source permet de créer une nouvelle branche de développement d'un code source de logiciel ou dans le cas présent, le code source de la documentation. En créant une nouvelle branche, cela vous permet de modifier le code et d'ajouter vos contributions sans altérer le code de la branche `master` qui est le rendu public de la documentation. Ce qui vous permet de ne pas devoir tout marquer mais le faire en plusieurs étapes. (Notamment pour les contributions demandant plus de temps de travail). -Forker un projet sur github est extrêmement simple, il suffit ce cliquer sur le bouton Fork, cela créera un nouveau dépôt sur votre espace de github. +Forker un projet sur GitHub est extrêmement simple, il suffit ce cliquer sur le bouton Fork, cela créera un nouveau dépôt sur votre espace de GitHub. ![Capture d'écran bouton fork github](/images/dug_fork.png) Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dépôt, dans le cas présent `YunoHost/doc` ![Capture d'écran titre et sous-titre du dépot](/images/dug_fork_source.png) From 738597941f062193ebd345b34edfa5039c26ca61 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:08:54 +0200 Subject: [PATCH 14/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 1b19372f..bc30dc16 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -17,7 +17,7 @@ Il est bien sûr possible de contribuer directement sur la documentation de Yuno Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur GitHub, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. GitHub est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utiliser un pseudonyme (lors de l'inscription `Username`). -*/iframe video creer compte github /* +*/iframe video creer compte GitHub /* ## Forker la documentation de YunoHost dans votre dépôt personel From c8a3f01d0b1dad77e968b7cfe45e0755dcaf2549 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:09:26 +0200 Subject: [PATCH 15/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index bc30dc16..f2e4f771 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -24,7 +24,7 @@ Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utilis Forker le code source permet de créer une nouvelle branche de développement d'un code source de logiciel ou dans le cas présent, le code source de la documentation. En créant une nouvelle branche, cela vous permet de modifier le code et d'ajouter vos contributions sans altérer le code de la branche `master` qui est le rendu public de la documentation. Ce qui vous permet de ne pas devoir tout marquer mais le faire en plusieurs étapes. (Notamment pour les contributions demandant plus de temps de travail). Forker un projet sur GitHub est extrêmement simple, il suffit ce cliquer sur le bouton Fork, cela créera un nouveau dépôt sur votre espace de GitHub. -![Capture d'écran bouton fork github](/images/dug_fork.png) +![Capture d'écran bouton fork GitHub](/images/dug_fork.png) Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dépôt, dans le cas présent `YunoHost/doc` ![Capture d'écran titre et sous-titre du dépot](/images/dug_fork_source.png) From 9b8b51ceca3eacb2e2d35f5f1a12b79c2a8c4537 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:09:39 +0200 Subject: [PATCH 16/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index f2e4f771..7ddea992 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -45,7 +45,7 @@ Plus d'informations sur qu'est une branche sur git-scm.com : [Les branches avec Faire une Pull Request correspond au moment ou vous souahitez partager votre travaille avec le reste des contributeurs⋅trices et l'intégrer au dépot master (dépôt principale de Yunohost). Lors de la publication d'un Pull Request, couramment nommé PR, les contributeurs⋅trices pourront amender, commenter, ajouter, corriger votre contribution avant intégration complète au dépot. ## Suivre votre contribution et prendre en compte les retours des contributeurs·trices -Lorsque vous avez déjà fait une PR (Pull Request), les modifications de votre branche de développement sur le dépôt git se rajouteront automatiquement à la PR. Cela ne nécessite aucune action supplémentaire. Vous pouvez aussi intégrer les propositions de modifications de contributeurs, qui lorsqu'ils/elles auditeront le code, peuvent trouver des erreurs ou de nouvelles formulations plus adaptées. +Lorsque vous avez déjà fait une PR (Pull Request), les modifications de votre branche de développement sur le dépôt Git se rajouteront automatiquement à la PR. Cela ne nécessite aucune action supplémentaire. Vous pouvez aussi intégrer les propositions de modifications de contributeurs, qui lorsqu'ils/elles auditeront le code, peuvent trouver des erreurs ou de nouvelles formulations plus adaptées. ## Faire remonter des erreurs et des souhaits par des issues YunoHost dispose d'un dépôt git spécifique pour le recueil des issues : [github.com/YunoHost/issues](https://github.com/YunoHost/issues) From 22efe375128d28765caf6ba7894092b41948467b Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:10:00 +0200 Subject: [PATCH 17/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 7ddea992..4b1a7b94 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -36,7 +36,7 @@ Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dép > Il n'est pas possible d'avoir un fork du dépot d'un contributeur et le fork dépôt d'origine au même moment dans votre propre dépôt. ## Modifier et ajouter votre contribution -Une fois le dépôt forker (copié), il faudra créer une nouvelle branche de développement au sein de votre dépôt. C'est à travers cette branche que vous allez modifier les fichiers et ainsi proposer des améliorations de la documentation. Le fait que ce soit une nouvelle branche vous permettra par la suite de faire une Pull Request, c'est à dire une demande d'ajout de vos contributions au sein de la branche `master` qui est la branche principale de la documentation. Les règles de développement sur github change selon les développeurs de chaque dépôt, certains ont une branche testing dans laquelle il faut proposer les contributions. +Une fois le dépôt forker (copié), il faudra créer une nouvelle branche de développement au sein de votre dépôt. C'est à travers cette branche que vous allez modifier les fichiers et ainsi proposer des améliorations de la documentation. Le fait que ce soit une nouvelle branche vous permettra par la suite de faire une Pull Request, c'est à dire une demande d'ajout de vos contributions au sein de la branche `master` qui est la branche principale de la documentation. Les règles de développement sur GitHub change selon les développeurs de chaque dépôt, certains ont une branche testing dans laquelle il faut proposer les contributions. Plus d'informations sur qu'est une branche sur git-scm.com : [Les branches avec Git - Ce qu'est une branche](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). */iframe video modifier fichiers ajouter contribution /* From b6892c5c8857a7442950f46ff3e87a77800902e0 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:10:15 +0200 Subject: [PATCH 18/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 4b1a7b94..581d67f1 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -48,7 +48,7 @@ Faire une Pull Request correspond au moment ou vous souahitez partager votre tra Lorsque vous avez déjà fait une PR (Pull Request), les modifications de votre branche de développement sur le dépôt Git se rajouteront automatiquement à la PR. Cela ne nécessite aucune action supplémentaire. Vous pouvez aussi intégrer les propositions de modifications de contributeurs, qui lorsqu'ils/elles auditeront le code, peuvent trouver des erreurs ou de nouvelles formulations plus adaptées. ## Faire remonter des erreurs et des souhaits par des issues -YunoHost dispose d'un dépôt git spécifique pour le recueil des issues : [github.com/YunoHost/issues](https://github.com/YunoHost/issues) +YunoHost dispose d'un dépôt Git spécifique pour le recueil des issues : [github.com/YunoHost/issues](https://github.com/YunoHost/issues) Une issue aussi appelé ticket, est un problème identifié ou alors un souhait de développement ; dans le cas présent pour la documentation, mais c'est valable pour tout dépôt logiciel. Dans le cadre de la documentation de YunoHost il sera surtout proposé des issues pour le développement de la documentation, les problèmes identifiés étant facilement corrigeable. ## Aller plus loin avec git et travailler sur son poste de travail From 52e3186d6203f5412ecaf3515349000bdcfe244c Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:10:27 +0200 Subject: [PATCH 19/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 581d67f1..b2a958e4 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -51,7 +51,7 @@ Lorsque vous avez déjà fait une PR (Pull Request), les modifications de votre YunoHost dispose d'un dépôt Git spécifique pour le recueil des issues : [github.com/YunoHost/issues](https://github.com/YunoHost/issues) Une issue aussi appelé ticket, est un problème identifié ou alors un souhait de développement ; dans le cas présent pour la documentation, mais c'est valable pour tout dépôt logiciel. Dans le cadre de la documentation de YunoHost il sera surtout proposé des issues pour le développement de la documentation, les problèmes identifiés étant facilement corrigeable. -## Aller plus loin avec git et travailler sur son poste de travail +## Aller plus loin avec Git et travailler sur son poste de travail Utiliser la puissance de git et ainsi travailler sur son ordinateur personnel, permet entre autres de ne pas avoir à créer de `commit` à chaque enregistrement intermédiaire des pages de documentations modifiées. Cela permet aussi d'utiliser des outils et logiciels qui permettent une distinction plus facile des codes utilisés dans une page de documentation. - Ressource en ligne : [docs.microsoft.com - Configurer un référentiel Git localement pour la documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) From b4ec9a7dabd89cd685d89064c0088433fb99a0fb Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:10:40 +0200 Subject: [PATCH 20/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index b2a958e4..fe12df5b 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -52,7 +52,7 @@ YunoHost dispose d'un dépôt Git spécifique pour le recueil des issues : [gith Une issue aussi appelé ticket, est un problème identifié ou alors un souhait de développement ; dans le cas présent pour la documentation, mais c'est valable pour tout dépôt logiciel. Dans le cadre de la documentation de YunoHost il sera surtout proposé des issues pour le développement de la documentation, les problèmes identifiés étant facilement corrigeable. ## Aller plus loin avec Git et travailler sur son poste de travail -Utiliser la puissance de git et ainsi travailler sur son ordinateur personnel, permet entre autres de ne pas avoir à créer de `commit` à chaque enregistrement intermédiaire des pages de documentations modifiées. Cela permet aussi d'utiliser des outils et logiciels qui permettent une distinction plus facile des codes utilisés dans une page de documentation. +Utiliser la puissance de Git et ainsi travailler sur son ordinateur personnel, permet entre autres de ne pas avoir à créer de `commit` à chaque enregistrement intermédiaire des pages de documentations modifiées. Cela permet aussi d'utiliser des outils et logiciels qui permettent une distinction plus facile des codes utilisés dans une page de documentation. - Ressource en ligne : [docs.microsoft.com - Configurer un référentiel Git localement pour la documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) From 02103f304c9c3dcde0d8e874610c379c386de549 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:10:53 +0200 Subject: [PATCH 21/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index fe12df5b..b76d345d 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -57,7 +57,7 @@ Utiliser la puissance de Git et ainsi travailler sur son ordinateur personnel, p - Ressource en ligne : [docs.microsoft.com - Configurer un référentiel Git localement pour la documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) ## Quelques ressources ailleurs sur le net pour aller plus loin - - [Gérer son code avec git et github - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) + - [Gérer son code avec Git et GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - [Interface utilisateurs·trices de git - git-scm.com](https://git-scm.com/download/gui/linux) */ To do/* From de1dcf32569cde5017ce5abbc654cd1512f66d64 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:11:05 +0200 Subject: [PATCH 22/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index b76d345d..aeca0165 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -58,7 +58,7 @@ Utiliser la puissance de Git et ainsi travailler sur son ordinateur personnel, p ## Quelques ressources ailleurs sur le net pour aller plus loin - [Gérer son code avec Git et GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - - [Interface utilisateurs·trices de git - git-scm.com](https://git-scm.com/download/gui/linux) + - [Interface utilisateurs·trices de Git - git-scm.com](https://git-scm.com/download/gui/linux) */ To do/* */Ajouter vidéos explicative - Add videos explication/* From 046b4143827c81724e0a3c48a69fb16c44009de1 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:11:25 +0200 Subject: [PATCH 23/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index aeca0165..6bb00132 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -28,7 +28,7 @@ Forker un projet sur GitHub est extrêmement simple, il suffit ce cliquer sur le Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dépôt, dans le cas présent `YunoHost/doc` ![Capture d'écran titre et sous-titre du dépot](/images/dug_fork_source.png) -*/iframe video forker code source github /* +*/iframe video forker code source GitHub /* > **Point de vigilance !** From 4dc212a86cb329932c123a22574322c1e9d35909 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:11:53 +0200 Subject: [PATCH 24/63] Update doc_markdown_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 0d71f6db..d2b54486 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -13,7 +13,7 @@ - [Les tableaux](#UtiliserTableaux) - [Bloc de Codes](#BlockCodes) -Le Markdown est un langage de balisage créé en 2004, de nombreux add-on développant les possibilités de ce langage existent. L'objectif de ce guide est de tendre vers l'exaustivité des possibilités de ce langage de formatage dans le cadre de la documentation de Yunohost et non du langage Markdown en général. +Le Markdown est un langage de balisage créé en 2004, de nombreux add-on développant les possibilités de ce langage existent. L'objectif de ce guide est de tendre vers l’exhaustivité des possibilités de ce langage de formatage dans le cadre de la documentation de YunoHost et non du langage Markdown en général. Markdown permet de formater du texte à l'aide de balises, il permet une lecture *humaine* du texte ; même avec le formatage. Même si un unique bloc note est nécessaire il existe de nombreux logiciels markdowns (Markdown sur [framalibre.org](https://framalibre.org/recherche-par-crit-res?keys=markdown)). Sa prise en main est relativement facile. From 336a0e8e0f521f0e14e50dccff4c2e8cd60b7b17 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:12:09 +0200 Subject: [PATCH 25/63] Update doc_markdown_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index d2b54486..fe53154d 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -44,7 +44,7 @@ Pour taper un retour à la ligne sans créer de nouveau paragraphe, il est néce En rédigeant ça : ```markdown -Pour du texte en *italique il faut encadrer par un astérique`*`* +Pour du texte en *italique il faut encadrer par un astérisque`*`* Pour rédiger du **texte en gras par deux astériques** On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` ``` From 4e3b88fde7caefa25f23a0bc03c358ef9125ae10 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:12:21 +0200 Subject: [PATCH 26/63] Update doc_markdown_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index fe53154d..18f214a6 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -51,7 +51,7 @@ On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` On peut lire ça : -Pour du texte en *italique il faut encadrer par un astérique `*` * +Pour du texte en *italique il faut encadrer par un astérisque `*` * Pour rédiger du **texte en gras par deux astériques** On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` From cc5801b4f8f8e0b828a227b903efd3382133495b Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:12:35 +0200 Subject: [PATCH 27/63] Update doc_markdown_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 18f214a6..8ced94a7 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -52,7 +52,7 @@ On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` On peut lire ça : Pour du texte en *italique il faut encadrer par un astérisque `*` * -Pour rédiger du **texte en gras par deux astériques** +Pour rédiger du **texte en gras par deux astérisques** On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` ## Créer des liens From edbf199db22892cb6a549b6f36696fd692157bca Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:12:46 +0200 Subject: [PATCH 28/63] Update doc_writing_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index 92f20f88..cb869d9a 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -1,4 +1,4 @@ -# Guide de rédaction de la documentation des apps +# Guide de rédaction de la documentation des applications ## Pages de documentations utilisateurs.trices / administrateurs⋅trices From 1defcdd7ed2b1ae2b5f09f6a7c345f2a168830be Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:12:55 +0200 Subject: [PATCH 29/63] Update doc_writing_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index cb869d9a..ce859813 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -60,4 +60,4 @@ YunoHost vers le site officiel ------- ------- ## Potentielles problématiques rencontrés ? -Quid des apps qui sont des containers à d'autres applications, tel que Nextcloud et qui présentes de multiples possibilités d'usages. +Quid des applications qui sont des containers à d'autres applications, tel que Nextcloud et qui présentes de multiples possibilités d'usages. From 3dece476e7bcf0ca425d6599b6ab15c7c6174b80 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:13:05 +0200 Subject: [PATCH 30/63] Update contributordoc_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- contributordoc_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributordoc_fr.md b/contributordoc_fr.md index ab1aef6a..9821b97c 100644 --- a/contributordoc_fr.md +++ b/contributordoc_fr.md @@ -7,7 +7,7 @@ * [Propulser son code avec Git & GitHub](/doc_use_git_fr) * [Salons de discussion](/chat_rooms) * Packaging d'application - * [Liste d'apps souhaitées par la communauté](/apps_wishlist) + * [Liste d'applications souhaitées par la communauté](/apps_wishlist) * [Introduction générale au packaging d'apps](/packaging_apps_start) * [Introduction technique au packaging d'apps](/packaging_apps) * [Déployer un environnement de développement avec VirtualBox](/packaging_apps_virtualbox) From 58265a9f363d2e687bc21d9cb82b3122e791f1ae Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:14:45 +0200 Subject: [PATCH 31/63] Update doc_writing_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index ce859813..00f7f44c 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -19,7 +19,7 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio 1. Une présentation général de l'application et de sa fonction. 1. Une partie administration de l'application. 1. Une partie aller plus loin, Manipulations techniques liés spécifiquement à YunoHost. - 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des apps officiels sont fournis. + 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des applications officiels sont fournis. + Une partie avec : - les liens vers le site officiel - Les liens vers le package de YunoHost From 751deb6b05884917a9526a4f69853abe133f587b Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:15:03 +0200 Subject: [PATCH 32/63] Update doc_writing_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index 00f7f44c..a0a30b7b 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -30,7 +30,7 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio 1. Documenter les applications. 1. Documenter les applications au travail (marqué : work) niveau 8/7/6. 1. Traduire la page de documentation à minima en français et en anglais. - 1. Faire une PR sur le dépot de l'app concerné vers la page de documentation. + 1. Faire une PR sur le dépôt de l'application concerné vers la page de documentation. ## Documenter une application From 83f7440c2c4ec566c0ed24f228345d08d012e4a7 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:15:15 +0200 Subject: [PATCH 33/63] Update doc_markdown_guide_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 8ced94a7..83b34be9 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -45,7 +45,7 @@ En rédigeant ça : ```markdown Pour du texte en *italique il faut encadrer par un astérisque`*`* -Pour rédiger du **texte en gras par deux astériques** +Pour rédiger du **texte en gras par deux astérisques** On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` ``` From 36241efdda18d83440a697729807ecb9eb4f57d9 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Wed, 1 Apr 2020 11:50:34 +0200 Subject: [PATCH 34/63] Update doc_markdown_guide_fr.md --- doc_markdown_guide_fr.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 83b34be9..1a8ac21d 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -227,24 +227,23 @@ Ce qui afficherait ça : ## Bloc de codes -Pour afficher du texte en brut, des `blocs de codes` peuvent être créer : +Pour afficher du texte en brut, des `blocs de codes` peuvent être créer en utilisant l'accent grave `Alt Gr + è` : ```` Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` ``` ou directement en bloc. -La seule différence est dans la quantité de : ` -Minimum ``` en ouverture et fermeture de bloc et deux ` qui encadre le morceau de texte à formater dans une ligne -``` -```` +La seule différence est dans la quantité d'accents graves : +Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne Ce qui donnera au rendu : Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` + ``` ou directement en bloc. -La seule différence est dans la quantité de : ` -Minimum ``` en ouverture et fermeture de bloc et deux ` qui encadre le morceau de texte à formater dans une ligne +La seule différence est dans la quantité d'accents graves : +Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne ``` ## Liens utiles From d5298a3030d0672314185041ce639c0860d99990 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Thu, 2 Apr 2020 10:55:44 +0200 Subject: [PATCH 35/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 6bb00132..faa2d579 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -1,4 +1,4 @@ -# Propulser une contribution avec git +# Propulser une contribution avec Git **Index** - [Création d'un compte sur github.com](#CreationCompteGithub) From 61d9bc942a1a065d6d8bf9314b7ec20fc8abdcc4 Mon Sep 17 00:00:00 2001 From: Plumf Date: Thu, 2 Apr 2020 13:35:00 +0200 Subject: [PATCH 36/63] Add informations in writing guide + example with app Pi Hole --- app_pihole_fr.md | 71 ++++++++++++++++++++++++++++++++++++++-- doc_writing_guide_fr.md | 8 +++-- images/pihole_logo.png | Bin 0 -> 2778 bytes 3 files changed, 73 insertions(+), 6 deletions(-) create mode 100644 images/pihole_logo.png diff --git a/app_pihole_fr.md b/app_pihole_fr.md index 4d2dbc39..98e7e6bc 100644 --- a/app_pihole_fr.md +++ b/app_pihole_fr.md @@ -1,5 +1,70 @@ -# Pihole +# logo de Pi-hole Pi-hole -Page d'accueil : https://pi-hole.net +[![Installer Pi-hole avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pihole)[![Niveau d'intégration](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) -**Pi-hole®** Blocage des publicités à l'échelle du réseau via votre propre serveur DNS, avec une belle page web Performance And Statistics. \ No newline at end of file +- [Utiliser Pi-Hole comme serveur DHCP](#utiliser-pi-Hole-comme-serveur-dhcp) + - [Configurer Pi-Hole](#configurer-pi-hole) + - [Configurer mon routeur](#configurer-mon-routeur) + - [Restaurer le réseau](#restaurer-le-reseau) +- [Liens utiles](#quelques-liens-utiles) + +Pi-hole est un bloqueur de publicité au niveau du réseau qui agit comme un DNS menteur et éventuellement un serveur DHCP3, destiné à être utilisé sur un réseau privé. Il est conçu pour être installé sur des périphériques intégrés dotés de capacités réseau, tels que le Raspberry Pi, mais il peut être utilisé sur d'autres machines exécutant Linux ou dans des environnements virtualisés. + +## Utiliser Pi-Hole comme serveur DHCP + +> **Attention, vous devez savoir que toucher à votre DHCP pourrait casser votre réseau. +Dans le cas où votre serveur serait inaccessible, vous perdriez votre résolution dns et votre adresse IP. +Ainsi, vous perdriez toute connexion à internet et même la connexion à votre routeur.** + +> **Si vous rencontrez ce genre de problèmes, merci de lire la section "Comment restaurer mon réseau".** + +### Configurer Pi-hole + +Il y a 2 manière de configurer Pi-hole pour qu'il soit utilisé comme votre serveur DHCP. +- Soit vous pouvez choisir de l'utiliser lorsque vous installez l'application. +- Soit vous pouvez activer le serveur DHCP par la suite dans l'onglet "Settings", partie "Pi-hole DHCP Server". +Dans ce second cas, il peut être préférable de forcer l'ip du serveur à une adresse statique. + +### Configurer mon routeur + +Votre routeur ou celui de votre FAI dispose d'un serveur DHCP activé par défaut. +Si vous gardez ce DHCP, en même temps que celui de Pi-hole, vous allez avoir des conflits transparents entre eux. +Le premier serveur DHCP à répondre va distribuer ses propres ip et paramètres. +Donc vous devez éteindre le serveur DHCP de votre routeur et laisser Pi-hole gérer votre réseau. + +#### Pourquoi je devrais utiliser le DHCP de Pi-hole ? + +En utilisant le DHCP de Pi-hole, vous lui permettez de donner sa configuration dns à chacun de vos clients. De cette manière, chaque requête sera filtrée par Pi-hole. + +Un autre cas d'usage du DHCP de Pi-hole est le cas où vous rencontrez des problèmes de hairpinning (Vous ne pouvez pas vous connecter à votre serveur parce que son ip est votre ip publique, et votre routeur n'autorise pas cela). +Dans ce cas, utilisez le dns de Pi-hole va vous permettre de vous connecter à votre serveur par son adresse locale plutôt que son adresse publique. + +### Restaurer le réseau + +> Oups ! +Votre serveur Pi-hole est tombé, et vous n'avez plus de DHCP. +Ne paniquez pas, on va surmonter ça \o/ + +Utilisez votre terminal favori sur votre ordinateur de bureau. +Et tout d'abord, récupérer votre interface réseau (Le plus souvent `eth0`). +``` bash +sudo ifconfig +``` + +Ensuite, changer votre ip pour une ip statique. +``` bash +sudo ifconfig eth0 192.168.1.100 +``` + +Maintenant, vous pouvez vous connecter à votre routeur et rallumer son serveur DHCP pour l'utiliser à nouveau. +Vous pouvez maintenant retirer votre ip statique et réobtenir une ip dynamique. +``` bash +sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0 +``` + +> N'oubliez pas d'éteindre le DHCP de votre routeur si votre serveur fonctionne à nouveau. + +## Quelques liens utiles + ++ Site officiel : [pi-hole.net](https://pi-hole.net) ++ Documentation Pi-Hole : [docs.pi-hole.net](https://docs.pi-hole.net/) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index a0a30b7b..b0bd44c5 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -11,19 +11,21 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio ## Quelques usages types et d'ordres général (trame de rédaction) + Lorsqu'un lien renvoi vers une page qui n'est pas dans la langue de la page d'origine, il est d'usage d'ajouter `(en)`(Pour un lien qui pointe vers une page en anglais). + + renommer les images dans l'ordre suivant :`nomapplication_descriptif.ext` ### Trame général documentation applications + 1. Logo (dimension 80 pixels de hauteurs) + titre de niveau 1. + 1. Bouton installer en un clique, Niveau d'intégration, et le status. 1. Un index en tête de documentations avec renvois vers l'ensemble des chapitres de la documentation. - 1. Bouton installer en un clique. 1. Une présentation général de l'application et de sa fonction. 1. Une partie administration de l'application. 1. Une partie aller plus loin, Manipulations techniques liés spécifiquement à YunoHost. 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des applications officiels sont fournis. - + Une partie avec : + 1. Documentation de l'utilisation si besoin (cf. Documenter une application). + 1. Une partie avec : - les liens vers le site officiel - Les liens vers le package de YunoHost - 1. Documentation de l'utilisation si besoin (cf. Documenter une application). ## Feuille de route diff --git a/images/pihole_logo.png b/images/pihole_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..178c085d5fa245987fffd29e7aa9222efb362dde GIT binary patch literal 2778 zcmV<03MKW4P)~Kfj)3xz9n24l@NZSu{dK6j4-=aO}ac7NRj~jGAK;O%YS6(r87i z%uz8FuauPK8m*MEyb_danY}RLfryBBVFZV3W@p8~01NB_yECuz$LqxvXLjDqydg_f zzJJY|?e6K%>+WCw`q#e|jLuzB@esmz@zADVzY>~7*d~gP1wPq0H*|3K-@uFWk6$TZMnC{!F_U7C@HWeMVUUpKp^74I!zK-US3z$uSZ!+ zfN?KXEWpD{X{=?32et~Ftptxkqf7%zOqt`)`fq4%36Qq7&hVfw7h!@x zKwzLiLg0ssXEYwjWuHR}^#TWgA!*juSl}JtLi3zXH;b?uc+N3Y<7^S3Qo+xG%Yot) z#cs#$U)F1m%?m=U0?%f685aYqfx{W5#Dnwe%7!`V#Ep%!zpdd-U@0&o4VX6TKPQ9I zsYiiChN(Oor~&qMQ|=og+>xmR-*23KGq4VrlA-9qOfNJeoK9FX)4)qM83oAh4h_;>z?_AqZIvRMw%mAla z;tHHuSPzhT-%GU*J^=gz_$~+vqiH6?`lmgpN_}dj- zKHr^XAD=)wnnB%rDCsn*redN9H6A$QOOGVAhXVY{BYK5`H6FnyfI{zAFhU8V#6Ep^ zj(b5V+7ZBmMufG%tjDvol8#2MQyb=n-V?YC*yP}C{TA?uJ>vVjOxpl(wNoQv*4g}A z!5qT@te+Fwjt!V;lkX2am`LgmfNOwu^ZnTx<~rlzIgQMEd`9Cww~jm+wQf$R?X5YX zMaK7A+fC65<&i1NOY2q(dXf3=Jm7*1KhX?ar{RXb&TMFP^E~HRZ&rlfMsv9dH`D*%f!Cgy)zDth^PC$huPajmqZRmS%IaS4{QmmY z^DpVJ+D8dG3Vib7?D~BaSW?KwCdK^85etxI6?!T;Q$JQPV7xxF1fx5@xF$V0t;>b3gynnM!{-G)sN%lCn zxIfqz_&cyLm-eR(hc<&y84!v0=3n? zz|exi8L*YW^g?744xKwY&j;B^JgfYq2&_({=Wt@n2q(gEtLeSzV5!NvW-q2@4p(!c|33asZC*RIdQ)xm=PS26Z%OzI(aNsvt*8K>WT@{P$P74?J2ZyzwYu~pL=kGx~O}*IC2Yx(P75Brw z6|Km@IXD6=df94!*0L{D&dlNEYzAg_1yo(Yikr3d{2HrcQWjtUV~;}P605zhHyWM? zoC7=peBsFI+fKoS-e~wq%MRL}nd8Wx3oNbn1^Rw%^5)t4PdE;t;3^Xs(k?gHUjx(B;8*Xi`;b_ZkK<|neSMMt^3gV z9uhwSE~tt{I5f_07b^p@1WQhoqK1H|N^dmW@wLOMi3!$Yr}<{9NG~X&-S1f0~4K8It@8CK^46_7@6mdhWDopGZ?^HoX0UbbWv6OzJR(6J=! zI*cCBu5~|w-hD)R^+!Bn_y296;zTgId&AYfz!2;xbEe#51YWyJ6%QbDhLGD@i#=j3 zjzfC@Rk6qc6YN==(MuN9($m1mWXY;xkro5^dUxggsF5cbY>kBYfj1g%%cXM8c_>`~LpycSW7*!mo2mg8<_eYDh@-8=Ec^{r#v2rzsT9Rdh1}|^boOQaW zah}{?+H=5--e~xkOA#=a7RaHN#1(@EElZ#e3=x^q3+aka zH)`ZL%5!@^ Date: Thu, 2 Apr 2020 13:36:19 +0200 Subject: [PATCH 37/63] Correction typographique MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git.md b/doc_use_git.md index fe2378d3..3d97c508 100644 --- a/doc_use_git.md +++ b/doc_use_git.md @@ -1 +1 @@ -# Propel your contribution with git +# Propel your contribution with Git From 9144fbae98d0730415bb3d66c4197c0fd51fd19d Mon Sep 17 00:00:00 2001 From: Plumf Date: Thu, 2 Apr 2020 23:07:28 +0200 Subject: [PATCH 38/63] =?UTF-8?q?D=C3=A9veloppement=20partie=20contenu=20d?= =?UTF-8?q?e=20la=20documentation.=20Ajout=20des=20limitations?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc_writing_guide_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index b0bd44c5..c44785a5 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -20,7 +20,7 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio 1. Un index en tête de documentations avec renvois vers l'ensemble des chapitres de la documentation. 1. Une présentation général de l'application et de sa fonction. 1. Une partie administration de l'application. - 1. Une partie aller plus loin, Manipulations techniques liés spécifiquement à YunoHost. + 1. Une partie aller plus loin, Manipulations techniques, liés spécifiquement à YunoHost mais aussi les limitations. 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des applications officiels sont fournis. 1. Documentation de l'utilisation si besoin (cf. Documenter une application). 1. Une partie avec : From c3d1897795016096216d5a8d0100de92a53a4804 Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 3 Apr 2020 12:12:03 +0200 Subject: [PATCH 39/63] Adding a framework for writing documentation --- app_writing_guide_fr.md | 26 ++++++++++++++++++++++++++ doc_writing_guide_fr.md | 2 ++ 2 files changed, 28 insertions(+) create mode 100644 app_writing_guide_fr.md diff --git a/app_writing_guide_fr.md b/app_writing_guide_fr.md new file mode 100644 index 00000000..8896a407 --- /dev/null +++ b/app_writing_guide_fr.md @@ -0,0 +1,26 @@ +# logo de Wallabag Wallabag + +[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/#.svg)](https://dash.yunohost.org/appci/app/APPLICATION) + +- [Limitations avec Yunohost](#limitations-avec-yunohost) +- [Applications clientes](#applications-clients) +- [Liens utiles](#liens-utiles) + +**Présentation générale de l'application.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* + +## Limitations avec Yunohost + +**Explication des limitations actuelles en utilisation l'application avec YunoHost.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* + +## Applications clientes + +| Nom de l'applications | Plateforme | Multi-comptes | Autre réseaux supportés | Play Store | F-Droid | Apple Store | *Autres* | +|-----------------------|------------|---------------|-------------------------|------------|---------|-------------|----------| +| | | | | | | | | + +## Liens utiles + + + Site web : [SITE WEB](#) + + Documentation officielle : [LIEN DOCUMENTATION](#) + + Dépôt logiciel de l'application : [github.com - YunoHost-Apps/APPLICATION](#) + + Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com -YunoHost-Apps/APPLICATION/issues](#) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index c44785a5..c04910fa 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -27,6 +27,8 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio - les liens vers le site officiel - Les liens vers le package de YunoHost +Trame markdown pour la rédaction des pages de documentations : [ici](/app_writing_guide_fr) + ## Feuille de route 1. Documenter les applications. From fe1cb829b083017931dbc6a6119cc761c42ead37 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Fri, 3 Apr 2020 12:13:49 +0200 Subject: [PATCH 40/63] Add index MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_markdown_guide.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc_markdown_guide.md b/doc_markdown_guide.md index 9fac816d..7afe55b8 100644 --- a/doc_markdown_guide.md +++ b/doc_markdown_guide.md @@ -1 +1,29 @@ # Markdown Guide + +**Index** + - [The different title levels](#TitleLevels) + - [Paragraph formatting](#ParagraphFormatting) + - [Link creation](#LinkCreation) + + [Anchor creation](#AnchorCreation) + - [Display images](#DisplayImages) + - [Citation formatting](#CitationFormatting + - [Lists](#Lists) + + [Ordered](#Ordered) + + [Unordered](#Unordered) + - [Tables](#Tables) + - [Code segments](#CodeSegments) + +Markdown is a markup language from 2004, with many add-ons supporting its function and existence. This guide explores the possibilities and formatting of the language in the context of YunoHost documentation, and not the Markdown language on its own. + +Markdown allows formatting of text using tags, in human-readable format; even with formatting. Outside of plaintext editors, a number of specific programs exist. (Markdown on [framalibre.org] (https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is easy to deal with. + +## The different title levels + +Write headlines like this: +```markdown +# Level 1 +## Level 2 +### Level 3 +#### Level 4 +##### Level 5 +###### Level 6 From ed0ba8a454194be9a9a02a24eb053059e025b2b7 Mon Sep 17 00:00:00 2001 From: Plumf Date: Mon, 6 Apr 2020 18:31:36 +0200 Subject: [PATCH 41/63] Add doc_use_git english version --- doc_use_git.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/doc_use_git.md b/doc_use_git.md index 3d97c508..968db224 100644 --- a/doc_use_git.md +++ b/doc_use_git.md @@ -1 +1,63 @@ -# Propel your contribution with Git +# Propel a contribution with Git + + **Index** + - [Creating an account on github.com](#CreationAccountGithub) + - [Fork the YunoHost documentation into your personal repository](#ForkerDocumentationYunoHost) + - [Edit files and add your contributions](#EditAddContrib) + - [Send your contributions with a Pull Request](#SendPR) + - [Track your contribution and take into account feedback from contributors](#TrackContributions) + - [Bringing up errors and wishes by creating a way out](#RemonterIssues) + - [Correct and Inspect Contributions](#ReviewContrib) + - [Going further with Git and working locally on his computer](#PlusLoinGitOrdi) + - [Some web resources](#WebLinks) + +It is of course possible to contribute directly to the YunoHost documentation, but this is not the most convenient way to do so for both the contributor and the person who will inject your contribution into the documentation. Here is a tutorial to understand and create a contribution to the Yunohost documentation using [Git](https://git-scm.com/) and [github.com](http://github.com/) which is the Git forge service that hosts and stores the YunoHost source code and documentation. + +## Create an account on github.com +To be able to send your contributions via GitHub, you need to have an account on GitHub, to create the account you will need a valid email address that you have access to. GitHub is a powerful tool with many features, the interface can be a little scary at first. +You don't have to give your first and last names, you can use a nickname (when you register `Username`). + +*/iframe video create a GitHub account /* + +## Fork the YunoHost documentation in your personal repository +To fork the source code allows you to create a new branch of development of a software source code or in this case the source code of the documentation. By creating a new branch, this allows you to modify the code and add your contributions without altering the code of the `master' branch, which is the public release of the documentation. This allows you not to have to write down everything at once, but to do it in several steps. (Especially for contributions that require more time). + +Forking a project on GitHub is extremely simple, just click on the Fork button, this will create a new repository on your GitHub account. +![Screenshot GitHub fork button screenshot](/images/dug_fork.png) +In the title of the new repository, you will see where the repository comes from, in this case `YunoHost/doc`. +![Screenshots title and subtitle of the repository](/images/dug_fork_source.png) + +*/iframe video forker source code GitHub /* + +> **Point of vigilance !** +> If you forge the repository of another contributor than yunohost, you'll get the same files. Except that when you send your changes, they will be sent to the contributor and not to the yunohost repository. The advantage is that it allows you to develop another branch created by the contributor and work with another person on an improvement before submitting it to the main repository. +> It is not possible to have a fork from a contributor's repository and the original repository fork at the same time in your own account. + +## Modify and add your contribution +Once the repository is forked (copied), you will need to create a new development branch within your repository. It is through this branch that you will modify the files and thus propose improvements to the documentation. The fact that it is a new branch will allow you to make a Pull Request, i.e. a request to add your contributions to the `master' branch, which is the main documentation branch. The development rules on GitHub change depending on the developers of each repository, some have a testing branch in which to offer contributions. +More information on what a branch on git-scm.com is: [Branching with Git - What a branch is](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). + +*/iframe video edit files add contribution /* + +## Send your contribution by a Pull Request +Create a Pull Request when you want to share your work with the other contributors and integrate it into the master repository (Yunohost's main repository). When publishing a Pull Request, commonly called PR, contributors will be able to amend, comment, add, correct your contribution before it is fully integrated into the repository. + +## Track your contribution and take into account feedback from contributors +When you've already create a Pull Request (PR), changes to your development branch in the Git repository will automatically be added to the PR. This doesn't require any additional action. You can also include proposed changes from contributors, who, when they audit the code, may find errors or new, better wording. + +## Bringing up mistakes and wishes through issues +YunoHost has a specific Git repository to collect issues: [github.com/YunoHost/issues](https://github.com/YunoHost/issues) +An issue, also called a ticket, is an identified problem or a development wish; in this case for documentation, but it is valid for any software repository. Within the framework of the YunoHost documentation it will be mainly proposed issues for the development of the documentation, the identified problems being easily correctable. + +## Going further with Git and working on his workstation +Using the power of Git to work on your personal computer means you don't have to create a `commit' each time you save modified documentation pages. It also allows you to use tools and software that make it easier to distinguish between tags used in a documentation page. + +- Online resource: [docs.microsoft.com - Setting up a Git repository locally for documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) + +## Some resources elsewhere on the net to go further + - [Managing your code with Git and GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) + - [Git User Interface - git-scm.com](https://git-scm.com/download/gui/linux) + +*/ To do/* +*/Add videos explanation/* - Add videos explanation/* +*/Add ## Correct and inspect contributions /* From 04602a6f161904789611c3e21d44e37c9a805353 Mon Sep 17 00:00:00 2001 From: Plumf Date: Tue, 7 Apr 2020 15:20:28 +0200 Subject: [PATCH 42/63] Update app writing guide fr --- app_writing_guide_fr.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/app_writing_guide_fr.md b/app_writing_guide_fr.md index 8896a407..f0b47e0d 100644 --- a/app_writing_guide_fr.md +++ b/app_writing_guide_fr.md @@ -1,13 +1,18 @@ -# logo de Wallabag Wallabag +# logo de APPLICATION APPLICATION -[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/#.svg)](https://dash.yunohost.org/appci/app/APPLICATION) +[![Install APPLICATION with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/#.svg)](https://dash.yunohost.org/appci/app/APPLICATION) +- [Configuration](#configuration) - [Limitations avec Yunohost](#limitations-avec-yunohost) - [Applications clientes](#applications-clients) - [Liens utiles](#liens-utiles) **Présentation générale de l'application.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* +## Configuration + +**Si la configuration de l'application ne se fait pas avec le panel admin de YunoHost** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* + ## Limitations avec Yunohost **Explication des limitations actuelles en utilisation l'application avec YunoHost.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* From bf1a036e817d1d2fcdc4329af734f95c19aeb219 Mon Sep 17 00:00:00 2001 From: Plumf Date: Tue, 7 Apr 2020 15:33:29 +0200 Subject: [PATCH 43/63] Update Writing guide fr + add english version --- app_writing_guide.md | 31 +++++++++++++++++++++++++++++++ app_writing_guide_fr.md | 10 +++++----- 2 files changed, 36 insertions(+), 5 deletions(-) create mode 100644 app_writing_guide.md diff --git a/app_writing_guide.md b/app_writing_guide.md new file mode 100644 index 00000000..abaef509 --- /dev/null +++ b/app_writing_guide.md @@ -0,0 +1,31 @@ +# APPLICATION's logo APPLICATION + +[![Install APPLICATION with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/APPLICATION.svg)](https://dash.yunohost.org/appci/app/APPLICATION) + +- [Configuration](#Configuration) +- [Limitations with YunoHost](#limitations-with-yunohost) +- [Customer Applications](#Customer-applications) +- [Useful links](#useful-links) + +**General presentation of the application.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* + +## Configuration + +**If the configuration of the application is not done with the admin panel of YunoHost.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* + +## Limitations with YunoHost + +**Explanation of the current limitations in using the application with YunoHost.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* + +## Customer applications + +| Application name | Platform | Multi-account | Other supported networks | Play Store | F-Droid | Apple Store | *Other* | +|------------------|----------|---------------|--------------------------|------------|---------|-------------|---------| +| | | | | | | | | + +## Useful links + ++ Website: [WEBSITE](#) ++ Official documentation: [DOCUMENTATION](#) ++ Application software repository: [github.com - YunoHost-Apps/APPLICATION](https://github.com/YunoHost-Apps/APPLICATION_ynh) ++ Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/APPLICATION/issues](https://github.com/YunoHost-Apps/APPLICATION_ynh/issues) diff --git a/app_writing_guide_fr.md b/app_writing_guide_fr.md index f0b47e0d..b39fdfec 100644 --- a/app_writing_guide_fr.md +++ b/app_writing_guide_fr.md @@ -1,6 +1,6 @@ # logo de APPLICATION APPLICATION -[![Install APPLICATION with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/#.svg)](https://dash.yunohost.org/appci/app/APPLICATION) +[![Install APPLICATION with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/APPLICATION.svg)](https://dash.yunohost.org/appci/app/APPLICATION) - [Configuration](#configuration) - [Limitations avec Yunohost](#limitations-avec-yunohost) @@ -11,7 +11,7 @@ ## Configuration -**Si la configuration de l'application ne se fait pas avec le panel admin de YunoHost** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* +**Si la configuration de l'application ne se fait pas avec le panel admin de YunoHost.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* ## Limitations avec Yunohost @@ -26,6 +26,6 @@ ## Liens utiles + Site web : [SITE WEB](#) - + Documentation officielle : [LIEN DOCUMENTATION](#) - + Dépôt logiciel de l'application : [github.com - YunoHost-Apps/APPLICATION](#) - + Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com -YunoHost-Apps/APPLICATION/issues](#) + + Documentation officielle : [DOCUMENTATION](#) + + Dépôt logiciel de l'application : [github.com - YunoHost-Apps/APPLICATION](https://github.com/YunoHost-Apps/APPLICATION_ynh) + + Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/APPLICATION/issues](https://github.com/YunoHost-Apps/APPLICATION_ynh/issues) From b8fe4c82d1b7c86ca7bd5dcf49655905740ffc79 Mon Sep 17 00:00:00 2001 From: Plumf Date: Tue, 14 Apr 2020 13:29:12 +0200 Subject: [PATCH 44/63] Various corrections --- app_writing_guide.md | 6 ++++-- app_writing_guide_fr.md | 8 +++++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/app_writing_guide.md b/app_writing_guide.md index abaef509..edd0f3db 100644 --- a/app_writing_guide.md +++ b/app_writing_guide.md @@ -2,9 +2,11 @@ [![Install APPLICATION with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/APPLICATION.svg)](https://dash.yunohost.org/appci/app/APPLICATION) -- [Configuration](#Configuration) +### Index + +- [Configuration](#configuration) - [Limitations with YunoHost](#limitations-with-yunohost) -- [Customer Applications](#Customer-applications) +- [Customer Applications](#customer-applications) - [Useful links](#useful-links) **General presentation of the application.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* diff --git a/app_writing_guide_fr.md b/app_writing_guide_fr.md index b39fdfec..bc5f08e1 100644 --- a/app_writing_guide_fr.md +++ b/app_writing_guide_fr.md @@ -2,9 +2,11 @@ [![Install APPLICATION with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=APPLICATION) [![Integration level](https://dash.yunohost.org/integration/APPLICATION.svg)](https://dash.yunohost.org/appci/app/APPLICATION) +### Index + - [Configuration](#configuration) -- [Limitations avec Yunohost](#limitations-avec-yunohost) -- [Applications clientes](#applications-clients) +- [Limitations avec YunoHost](#limitations-avec-yunohost) +- [Applications clientes](#applications-clientes) - [Liens utiles](#liens-utiles) **Présentation générale de l'application.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* @@ -13,7 +15,7 @@ **Si la configuration de l'application ne se fait pas avec le panel admin de YunoHost.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* -## Limitations avec Yunohost +## Limitations avec YunoHost **Explication des limitations actuelles en utilisation l'application avec YunoHost.** *Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce rutrum sodales mauris eu viverra. Sed dapibus, tellus sit amet interdum condimentum, enim eros faucibus ligula, sed suscipit orci velit at felis. Etiam quam lacus, vulputate eu scelerisque ac, sollicitudin rutrum orci. Cras eu ante porttitor, laoreet odio sed, hendrerit tellus. Nulla luctus sem in arcu scelerisque cursus. Nulla ut tellus at leo porttitor tincidunt. Morbi vitae purus convallis, elementum lectus non, dignissim orci. Integer eget egestas mauris. Nunc nunc dolor, cursus in quam mollis, rutrum fermentum nibh. Aliquam molestie velit a nulla porttitor, sit amet tincidunt erat laoreet.* From c399634638feeb9c9de48ca863168c0b0a4654ae Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 17 Apr 2020 11:48:51 +0200 Subject: [PATCH 45/63] Update and various corrections --- contributordoc.md | 3 ++ contributordoc_fr.md | 6 ++-- doc_markdown_guide.md | 15 +------- doc_markdown_guide_fr.md | 78 ++++++++++++++++++---------------------- doc_use_git.md | 29 +++++---------- doc_use_git_fr.md | 28 +++++---------- doc_writing_guide.md | 50 +++++++++++++------------- doc_writing_guide_fr.md | 46 +++++------------------- 8 files changed, 93 insertions(+), 162 deletions(-) diff --git a/contributordoc.md b/contributordoc.md index 31bc784e..9d6a6212 100644 --- a/contributordoc.md +++ b/contributordoc.md @@ -2,6 +2,9 @@ * [General ways of contributing to YunoHost](/contribute) * [Writing documentation](/write_documentation) + * [Documentation wrinting guide](doc_writing_guide) + * [markdown guide](/doc_markdown_guide) + * [Propulser son code avec Git & GitHub](/doc_use_git) * [Chat rooms](/chat_rooms) * Application packaging * [Apps wishlist](/apps_wishlist) diff --git a/contributordoc_fr.md b/contributordoc_fr.md index 9821b97c..afcc9e9b 100644 --- a/contributordoc_fr.md +++ b/contributordoc_fr.md @@ -2,9 +2,9 @@ * [Liste des façons de contribuer à YunoHost](/contribute) * [Écrire de la documentation](/write_documentation) - * [Guide de redaction de la documentation](dc_writing_guide_fr) - * [Guide markdown](/doc_markdown_guide_fr) - * [Propulser son code avec Git & GitHub](/doc_use_git_fr) + * [Guide de redaction de la documentation](doc_writing_guide) + * [Guide markdown](/doc_markdown_guide) + * [Propulser son code avec Git & GitHub](/doc_use_git) * [Salons de discussion](/chat_rooms) * Packaging d'application * [Liste d'applications souhaitées par la communauté](/apps_wishlist) diff --git a/doc_markdown_guide.md b/doc_markdown_guide.md index 7afe55b8..b42deefe 100644 --- a/doc_markdown_guide.md +++ b/doc_markdown_guide.md @@ -1,21 +1,8 @@ # Markdown Guide -**Index** - - [The different title levels](#TitleLevels) - - [Paragraph formatting](#ParagraphFormatting) - - [Link creation](#LinkCreation) - + [Anchor creation](#AnchorCreation) - - [Display images](#DisplayImages) - - [Citation formatting](#CitationFormatting - - [Lists](#Lists) - + [Ordered](#Ordered) - + [Unordered](#Unordered) - - [Tables](#Tables) - - [Code segments](#CodeSegments) - Markdown is a markup language from 2004, with many add-ons supporting its function and existence. This guide explores the possibilities and formatting of the language in the context of YunoHost documentation, and not the Markdown language on its own. -Markdown allows formatting of text using tags, in human-readable format; even with formatting. Outside of plaintext editors, a number of specific programs exist. (Markdown on [framalibre.org] (https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is easy to deal with. +Markdown allows formatting of text using tags, in human-readable format; even with formatting. Outside of plaintext editors, a number of specific programs exist. (Markdown on [framalibre.org](https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is easy to deal with. ## The different title levels diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 1a8ac21d..dcc12fca 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -1,23 +1,10 @@ # Guide Markdown -**Index** - - [Les différents niveaux de titres](#NiveauxTitres) - - [Formatage dans les paragraphes](#FormatageParagraphe) - - [Créer des liens](#CreerLiens) - + [Créer des ancres](#LiensAncres) - - [Afficher des images](#AfficherImages) - - [Formater une citation](#FormaterCitation) - - [Les listes](#UtiliserListes) - + [Listes ordonnées](#ListesOrdonnees) - + [Listes non ordonnées](#ListesNonOrdonnees) - - [Les tableaux](#UtiliserTableaux) - - [Bloc de Codes](#BlockCodes) - -Le Markdown est un langage de balisage créé en 2004, de nombreux add-on développant les possibilités de ce langage existent. L'objectif de ce guide est de tendre vers l’exhaustivité des possibilités de ce langage de formatage dans le cadre de la documentation de YunoHost et non du langage Markdown en général. +Le Markdown est un langage de balisage créé en 2004, de nombreux add-on développant les possibilités de ce langage existent. L'objectif de ce guide est de tendre vers l’exhaustivité des possibilités de ce langage de formatage dans le cadre de la documentation de YunoHost et non des langages Markdown en général. Markdown permet de formater du texte à l'aide de balises, il permet une lecture *humaine* du texte ; même avec le formatage. Même si un unique bloc note est nécessaire il existe de nombreux logiciels markdowns (Markdown sur [framalibre.org](https://framalibre.org/recherche-par-crit-res?keys=markdown)). Sa prise en main est relativement facile. -## Les différents niveaux de titres +## Les différents niveaux de titres En rédigeant des titres comme suit : ```markdown @@ -37,7 +24,7 @@ Ils apparaissent comme cela : ##### Titre de niveau 5 ###### Titre de niveau 6 -## Formatage dans les paragraphes +## Formatage dans les paragraphes Pour taper un retour à la ligne sans créer de nouveau paragraphe, il est nécessaire de taper **deux espaces consécutifs**.Sans cela, le texte continuera à la suite en respectant les contraintes générales du style de la page. @@ -55,7 +42,7 @@ Pour du texte en *italique il faut encadrer par un astérisque `*` * Pour rédiger du **texte en gras par deux astérisques** On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` -## Créer des liens +## Créer des liens Pour créer un lien vers un site hors de la documentation de YunoHost : @@ -66,16 +53,17 @@ Pour créer un lien vers un site hors de la documentation de YunoHost : s'affichera comme tel : [Texte à afficher](https://lelien.tld) -C'est identique pour les pages de la documentation, excepté que le lien est interne. Il renvoie au fichier du wiki, sans extension de fichier (le `.md`) : +C'est identique pour les pages de la documentation, excepté que le lien est interne. Il renvoie au fichier du wiki, sans extension de langgue et de fichier (le `_fr.md`) : +```markdown +[Page du wiki](/write_documentation) ``` -[Page du wiki](write_documentation_fr) -``` -[Page du wiki](write_documentation) -### Créer des ancres +[Page du wiki](/write_documentation) + +### Créer des ancres Une ancre permet de faire un lien vers un point précis dans une page, c'est comme ça que fonctionnent les index en haut de page. Pour créer une ancre, il faut insérer du code à l'endroit de l'ancre sous la forme suivante : -``` +```markdown Du texte qui sera ne sait même pas qu'il a une ancre ``` @@ -84,33 +72,35 @@ Du texte qui sera ne sait même pas qu'il a une ancre Il ne reste plus qu'à désigner l'ancre au texte que l'on souhaite rendre interactif : -``` -[Mon titre qui renvoie](#NomDeLAncre) +```markdown +[Mon titre qui renvoie](#nom-du-titre) ``` -[Mon titre qui renvoie](#NomDeLAncre) +[Mon titre qui renvoie](#nom-du-titre) -## Afficher des images +## Afficher des images Pour afficher des images, le principe est identique aux liens, excepté l'ajout d'un `!` avant le texte à afficher qui est ici considéré comme le texte à afficher en cas d'impossibilité de chargement de l'image. Une description de l'image convient. -``` +```markdown ![Logo Yunohost](/images/logo.png) ``` ![Logo Yunohost](/images/logo.png) + Il est possible de faire un lien avec une image, exemple : +```markdown +[![Logo Yunohost](/images/logo.png)](/write_documentation) ``` -[![Logo Yunohost](/images/logo.png)](write_documentation) -``` -[![Logo Yunohost](/images/logo.png)](write_documentation) +[![Logo Yunohost](/images/logo.png)](/write_documentation) L'encart de *texte à afficher en cas d'impossibilité de chargement de l'image* n'est pas obligatoire mais fortement recommandé. -## Formater une citation +## Formater une citation Les citations permettent de mettre en valeur un propos tenu par une autre personne, le wiki gère lui même la façon dont c'est valorisé. Markdown utilise un chevron fermant, ce symbole : `>`, pour annoncer une citation. Il suffit de les rajouter avant la citation, comme tel : -``` + +```markdown >Du texte de citation du premier niveau >qui peut être formaté en différentes lignes @@ -125,15 +115,15 @@ S'affichera : >> Et une seconde citation >> avec des doubles chevrons -## Les listes +## Les listes Les listes permettent d'afficher une suite de textes dans une présentation facile, c'est ainsi que sont rédiger les index tels que celui de la page de la [documentation contributeur](contributordoc). -### Listes ordonnées +### Listes ordonnées Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'est pas obligé de donner la bonne correspondance au nombre. Il est possible de noter avec des `1.` comme des `7.` et installer trois espaces pour marquer l'incrémentation. Pour une meilleure compréhension du texte brut, il peut être bien d'utiliser les chiffres de manières croissantes pour marquer l'incrémentation, mais c'est bien les trois `espaces` conséquents avant la sous-liste qui désigneront l'incrémentation. -``` +```markdown 1. Liste 1 1. Liste 2 1. liste 3 @@ -167,11 +157,11 @@ On obtient : 3. Liste 5 4. liste 6 -### Listes non ordonnées +### Listes non ordonnées Pour créer une liste non ordonnée, il faut utiliser les symboles `*`, `+` ou `*`. Cela ne changera pas l'apparence du marqueur dans la restitution du texte. C'est l'incrémentation de la liste qui définira le visuel. Pour une meilleure lecture du texte brut, il peut être bien d'utiliser les différents symboles pour marquer l'incrémentation, mais c'est bien les trois espaces avant la sous-liste qui désigneront l'incrémentation. Comme tel : -``` +```markdown + Liste 1 + Liste 2 + liste 3 @@ -204,7 +194,7 @@ Ce qui affichera : * Liste 5 + liste 6 -## Les tableaux +## Les tableaux Pour créer un tableau, il faut utiliser la barre verticale `|` et les tirets `-`. Il est obligatoire d'ajouter une ligne de tiret sous la première ligne du tableau. Il n'y a aucune contrainte dans la taille de ce dernier. Il est possible de formater le tableau avec les `:` dans la seconde ligne du tableau, trois options s'offrent à vous : @@ -212,7 +202,7 @@ Pour créer un tableau, il faut utiliser la barre verticale `|` et les tirets `- |:-------------------------|:---------------:|-------------------------:| |`:-----` | `:----:` | `-----:` | -``` +```markdown | **Un tableau** | Une colonne | Une seconde | Autant que l'on veut | |:--------------:|:-----------:|:-----------:|:--------------------:| | Une ligne formatée | | Et du **texte en gras** | Ou en *italique* | @@ -225,15 +215,15 @@ Ce qui afficherait ça : | Une ligne formatée | | Et du **texte en gras** | Ou en *italique* | | D'autres lignes | |![une image](/images/cd.jpg) | [Ou un lien]( contributordoc) | -## Bloc de codes +## Bloc de codes Pour afficher du texte en brut, des `blocs de codes` peuvent être créer en utilisant l'accent grave `Alt Gr + è` : -```` +````markdown Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` ``` ou directement en bloc. -La seule différence est dans la quantité d'accents graves : +La seule différence est dans la quantité d'accents graves : Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne Ce qui donnera au rendu : @@ -246,7 +236,7 @@ La seule différence est dans la quantité d'accents graves : Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne ``` -## Liens utiles +## Liens utiles + La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) + Tutoriel Markdown sur [markdowntutorial.com (en)](https://markdowntutorial.com) diff --git a/doc_use_git.md b/doc_use_git.md index 968db224..bc875f29 100644 --- a/doc_use_git.md +++ b/doc_use_git.md @@ -1,25 +1,14 @@ -# Propel a contribution with Git - - **Index** - - [Creating an account on github.com](#CreationAccountGithub) - - [Fork the YunoHost documentation into your personal repository](#ForkerDocumentationYunoHost) - - [Edit files and add your contributions](#EditAddContrib) - - [Send your contributions with a Pull Request](#SendPR) - - [Track your contribution and take into account feedback from contributors](#TrackContributions) - - [Bringing up errors and wishes by creating a way out](#RemonterIssues) - - [Correct and Inspect Contributions](#ReviewContrib) - - [Going further with Git and working locally on his computer](#PlusLoinGitOrdi) - - [Some web resources](#WebLinks) +# Propel a contribution with GitHub It is of course possible to contribute directly to the YunoHost documentation, but this is not the most convenient way to do so for both the contributor and the person who will inject your contribution into the documentation. Here is a tutorial to understand and create a contribution to the Yunohost documentation using [Git](https://git-scm.com/) and [github.com](http://github.com/) which is the Git forge service that hosts and stores the YunoHost source code and documentation. -## Create an account on github.com +## Create an account on github.com To be able to send your contributions via GitHub, you need to have an account on GitHub, to create the account you will need a valid email address that you have access to. GitHub is a powerful tool with many features, the interface can be a little scary at first. You don't have to give your first and last names, you can use a nickname (when you register `Username`). */iframe video create a GitHub account /* -## Fork the YunoHost documentation in your personal repository +## Fork the YunoHost documentation in your personal repository To fork the source code allows you to create a new branch of development of a software source code or in this case the source code of the documentation. By creating a new branch, this allows you to modify the code and add your contributions without altering the code of the `master' branch, which is the public release of the documentation. This allows you not to have to write down everything at once, but to do it in several steps. (Especially for contributions that require more time). Forking a project on GitHub is extremely simple, just click on the Fork button, this will create a new repository on your GitHub account. @@ -33,28 +22,28 @@ In the title of the new repository, you will see where the repository comes from > If you forge the repository of another contributor than yunohost, you'll get the same files. Except that when you send your changes, they will be sent to the contributor and not to the yunohost repository. The advantage is that it allows you to develop another branch created by the contributor and work with another person on an improvement before submitting it to the main repository. > It is not possible to have a fork from a contributor's repository and the original repository fork at the same time in your own account. -## Modify and add your contribution +## Modify and add your contribution Once the repository is forked (copied), you will need to create a new development branch within your repository. It is through this branch that you will modify the files and thus propose improvements to the documentation. The fact that it is a new branch will allow you to make a Pull Request, i.e. a request to add your contributions to the `master' branch, which is the main documentation branch. The development rules on GitHub change depending on the developers of each repository, some have a testing branch in which to offer contributions. More information on what a branch on git-scm.com is: [Branching with Git - What a branch is](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). */iframe video edit files add contribution /* -## Send your contribution by a Pull Request +## Send your contribution by a Pull Request Create a Pull Request when you want to share your work with the other contributors and integrate it into the master repository (Yunohost's main repository). When publishing a Pull Request, commonly called PR, contributors will be able to amend, comment, add, correct your contribution before it is fully integrated into the repository. -## Track your contribution and take into account feedback from contributors +## Track your contribution and take into account feedback from contributors When you've already create a Pull Request (PR), changes to your development branch in the Git repository will automatically be added to the PR. This doesn't require any additional action. You can also include proposed changes from contributors, who, when they audit the code, may find errors or new, better wording. -## Bringing up mistakes and wishes through issues +## Bringing up mistakes and wishes through issues YunoHost has a specific Git repository to collect issues: [github.com/YunoHost/issues](https://github.com/YunoHost/issues) An issue, also called a ticket, is an identified problem or a development wish; in this case for documentation, but it is valid for any software repository. Within the framework of the YunoHost documentation it will be mainly proposed issues for the development of the documentation, the identified problems being easily correctable. -## Going further with Git and working on his workstation +## Going further with Git and working on his workstation Using the power of Git to work on your personal computer means you don't have to create a `commit' each time you save modified documentation pages. It also allows you to use tools and software that make it easier to distinguish between tags used in a documentation page. - Online resource: [docs.microsoft.com - Setting up a Git repository locally for documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) -## Some resources elsewhere on the net to go further +## Some resources elsewhere on the net to go further - [Managing your code with Git and GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - [Git User Interface - git-scm.com](https://git-scm.com/download/gui/linux) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index faa2d579..3590179b 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -1,26 +1,15 @@ # Propulser une contribution avec Git -**Index** - - [Création d'un compte sur github.com](#CreationCompteGithub) - - [Forker la documentation de YunoHost dans votre dépôt personnel](#ForkerDocumentationYunoHost) - - [Modifier les fichiers et ajouter vos contributions](#ModifAjoutContrib) - - [Envoyer vos contributions avec une Pull Request](#EnvoyerPR) - - [Suivre votre contribution et prendre en compte les retours des contributeurs·trices](#SuivreContributions) - - [Faire remonter des erreurs et des souhaits en créant une issue](#RemonterIssues) - - [Corriger et inspecter les contributions](#ReviewContrib) - - [Aller plus loin avec Git et travailler en local sur son ordinateur](#PlusLoinGitOrdi) - - [Quelques ressources sur le web](#LiensWeb) - Il est bien sûr possible de contribuer directement sur la documentation de YunoHost, mais ce n'est pas la manière la plus pratique de le faire tant pour le/la contributeur·trice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de Yunohost en utilisant l'outil [Git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge Git qui héberge et stocke le code source de YunoHost ainsi que sa documentation. -## Création d'un compte sur github.com +## Création d'un compte sur github.com Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur GitHub, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. GitHub est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utiliser un pseudonyme (lors de l'inscription `Username`). */iframe video creer compte GitHub /* -## Forker la documentation de YunoHost dans votre dépôt personel +## Forker la documentation de YunoHost dans votre dépôt personel Forker le code source permet de créer une nouvelle branche de développement d'un code source de logiciel ou dans le cas présent, le code source de la documentation. En créant une nouvelle branche, cela vous permet de modifier le code et d'ajouter vos contributions sans altérer le code de la branche `master` qui est le rendu public de la documentation. Ce qui vous permet de ne pas devoir tout marquer mais le faire en plusieurs étapes. (Notamment pour les contributions demandant plus de temps de travail). Forker un projet sur GitHub est extrêmement simple, il suffit ce cliquer sur le bouton Fork, cela créera un nouveau dépôt sur votre espace de GitHub. @@ -30,33 +19,32 @@ Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dép */iframe video forker code source GitHub /* - > **Point de vigilance !** > Si vous forkez le dépôt d'un autre contributeur que yunohost, vous aurez les mêmes fichiers. Sauf que quand vous enverrez vos modifications, elles seront envoyées au contributeur et non au dépôt yunohost. L'avantage est que ça vous permet de développer une autre branche créee par le contributeur et ainsi travailler avec une autre personne à une amélioration avant proposition au dépôt principal. > Il n'est pas possible d'avoir un fork du dépot d'un contributeur et le fork dépôt d'origine au même moment dans votre propre dépôt. -## Modifier et ajouter votre contribution +## Modifier et ajouter votre contribution Une fois le dépôt forker (copié), il faudra créer une nouvelle branche de développement au sein de votre dépôt. C'est à travers cette branche que vous allez modifier les fichiers et ainsi proposer des améliorations de la documentation. Le fait que ce soit une nouvelle branche vous permettra par la suite de faire une Pull Request, c'est à dire une demande d'ajout de vos contributions au sein de la branche `master` qui est la branche principale de la documentation. Les règles de développement sur GitHub change selon les développeurs de chaque dépôt, certains ont une branche testing dans laquelle il faut proposer les contributions. Plus d'informations sur qu'est une branche sur git-scm.com : [Les branches avec Git - Ce qu'est une branche](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). */iframe video modifier fichiers ajouter contribution /* -## Envoyer votre contribution par une Pull Request +## Envoyer votre contribution par une Pull Request Faire une Pull Request correspond au moment ou vous souahitez partager votre travaille avec le reste des contributeurs⋅trices et l'intégrer au dépot master (dépôt principale de Yunohost). Lors de la publication d'un Pull Request, couramment nommé PR, les contributeurs⋅trices pourront amender, commenter, ajouter, corriger votre contribution avant intégration complète au dépot. -## Suivre votre contribution et prendre en compte les retours des contributeurs·trices +## Suivre votre contribution et prendre en compte les retours des contributeurs·trices Lorsque vous avez déjà fait une PR (Pull Request), les modifications de votre branche de développement sur le dépôt Git se rajouteront automatiquement à la PR. Cela ne nécessite aucune action supplémentaire. Vous pouvez aussi intégrer les propositions de modifications de contributeurs, qui lorsqu'ils/elles auditeront le code, peuvent trouver des erreurs ou de nouvelles formulations plus adaptées. -## Faire remonter des erreurs et des souhaits par des issues +## Faire remonter des erreurs et des souhaits par des issues YunoHost dispose d'un dépôt Git spécifique pour le recueil des issues : [github.com/YunoHost/issues](https://github.com/YunoHost/issues) Une issue aussi appelé ticket, est un problème identifié ou alors un souhait de développement ; dans le cas présent pour la documentation, mais c'est valable pour tout dépôt logiciel. Dans le cadre de la documentation de YunoHost il sera surtout proposé des issues pour le développement de la documentation, les problèmes identifiés étant facilement corrigeable. -## Aller plus loin avec Git et travailler sur son poste de travail +## Aller plus loin avec Git et travailler sur son poste de travail Utiliser la puissance de Git et ainsi travailler sur son ordinateur personnel, permet entre autres de ne pas avoir à créer de `commit` à chaque enregistrement intermédiaire des pages de documentations modifiées. Cela permet aussi d'utiliser des outils et logiciels qui permettent une distinction plus facile des codes utilisés dans une page de documentation. - Ressource en ligne : [docs.microsoft.com - Configurer un référentiel Git localement pour la documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) -## Quelques ressources ailleurs sur le net pour aller plus loin +## Quelques ressources ailleurs sur le net pour aller plus loin - [Gérer son code avec Git et GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - [Interface utilisateurs·trices de Git - git-scm.com](https://git-scm.com/download/gui/linux) diff --git a/doc_writing_guide.md b/doc_writing_guide.md index ec2e62da..14d64208 100644 --- a/doc_writing_guide.md +++ b/doc_writing_guide.md @@ -1,37 +1,39 @@ # Guide to writing application documentation -## Pages for user / administative documentation +## User documentation pages / administrateurs⋅trices -Add a one-click installation button (like for example: https://yunohost.org/#/app_piwigo) +Add a one-click install button (such as https://yunohost.org/#/app_piwigo_fr) and a button on the application integration level. -Classification of the application can be done using the available tags (genre, Git, management association, e-mails, etc.) -*/Find a suitable documentation license. Permissive or not? (CC BY_SA)/* +Classification of available applications by tags (genre, Git, association management, emails, etc.). -## Clarify the types of uses it has (special and general application (editorial choice) +*/Definition of a license to distribute the documentation, but which one? Permissive or not (CC BY-SA)/* - + For links to other languages, add (en)` for Egnlish, and so on. +## Some typical and general uses (writing framework) -### Things to include in application documentation + + When a link points to a page that is not in the language of the original page, it is customary to add `(en)` (for a link that points to a page in English). + + rename the images in the following order:`description_application.ext`. - 1. An index of what is included, without reiterating the full content of what is to be found in subsequent chapters. - 1. A one-click install button. +### General frame application documentation + + 1. Logo (dimension 80 pixels high) + level 1 title. + 1. One-click install button, Integration level for each type of processor. + 1. An index at the top of the documentation with cross-references to all the chapters of the documentation. 1. A general presentation of the application and its function. - 1. A section detailing administration of the application. - 1. A further section on changes specific to YunoHost. - 1. A section about the desktop client (if applicable). Links to different third party applications (if they exist), (or a link to a list of applications [framalibre.org](https://framalibre.org)) or a link to a page that has to do with the different official applications (if applicable). - + A further section: - - Links to the official website. - - Links to the package in YunoHost. - 1. Documentation of any further uses (documentation of an application). + 2. A configuration part of the application. + 1. An administration part of the application. + 1. A part on limitations related to YunoHost. + 1. A part on desktop clients (if any). A link to different third-party applications if there are several (possible link to the applications catalgue [framalibre.org](https://framalibre.org)) or a link to the page about desktop applications if official applications are provided. + 1. A part with : + - the link to the official site + - the link to the documentation + - Links to the YunoHost package and issues + +Screen for writing documentation pages: [here](/app_writing_guide) ## Roadmap -1. Documentation of the applications. - 1. Document how the application operates in use (marked: work) level 8/7/6. - 1. Translate the documentation at-least into French and English. - 1. Send a PR to the repository of the app that details its documentation. - -## Document an application - -Do you need to detail how it works? +1. Document applications. + 1. Document applications at work (marked: work) level 8/7/6. + 1. Translate the documentation page at least into French and English. + 1. Do a PR on the application repository diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index c04910fa..f62f3598 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -2,7 +2,8 @@ ## Pages de documentations utilisateurs.trices / administrateurs⋅trices -Ajouter un bouton installer en un clique (comme par exemple : https://yunohost.org/#/app_piwigo_fr) +Ajouter un bouton installer en un clique (comme par exemple : https://yunohost.org/#/app_piwigo_fr) et un bouton sur le niveau d'intégration de l'application. + Classement des applications disponibles par tags (genre, Git, gestion associations, courriels, etc.). @@ -16,18 +17,19 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio ### Trame général documentation applications 1. Logo (dimension 80 pixels de hauteurs) + titre de niveau 1. - 1. Bouton installer en un clique, Niveau d'intégration, et le status. + 1. Bouton installer en un clique, Niveau d'intégration pour chaque type de processeur. 1. Un index en tête de documentations avec renvois vers l'ensemble des chapitres de la documentation. 1. Une présentation général de l'application et de sa fonction. + 2. UNe partie configuration de l'application. 1. Une partie administration de l'application. - 1. Une partie aller plus loin, Manipulations techniques, liés spécifiquement à YunoHost mais aussi les limitations. + 1. Une partie sur les limitation liés à YunoHost. 1. Une partie sur les client desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalgue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des applications officiels sont fournis. - 1. Documentation de l'utilisation si besoin (cf. Documenter une application). 1. Une partie avec : - - les liens vers le site officiel - - Les liens vers le package de YunoHost + - le lien vers le site officiel + - le lien vers la documentation + - Les liens vers le package de YunoHost et issues -Trame markdown pour la rédaction des pages de documentations : [ici](/app_writing_guide_fr) +Trame pour la rédaction des pages de documentations : [ici](/app_writing_guide) ## Feuille de route @@ -35,33 +37,3 @@ Trame markdown pour la rédaction des pages de documentations : [ici](/app_writi 1. Documenter les applications au travail (marqué : work) niveau 8/7/6. 1. Traduire la page de documentation à minima en français et en anglais. 1. Faire une PR sur le dépôt de l'application concerné vers la page de documentation. - -## Documenter une application - -Faut-il documenter son utilisation ? - -``` -La documentation de l'application est elle disponible en français & en anglais ? - / \ - / \ - / \ - / \ - / \ - ------- ------- - | Oui | | Non |----> Documenter l'application <----<----<----<----- - ------- ------- dans la documentation de YunoHost | - | | - La documentation utilisateur est elle de bonne qualité et suffisante ? | - / \ | - / \ | - / \ | - / \ | - / \ | - ------- ------- | - Renvoi dans la page de doc ------- | Oui | | Non |---->---->---->---->---->---->---->---->---->---->---->---->---->- -YunoHost vers le site officiel ------- ------- -``` - -## Potentielles problématiques rencontrés ? - -Quid des applications qui sont des containers à d'autres applications, tel que Nextcloud et qui présentes de multiples possibilités d'usages. From 3399103b50125f2cc0a5fd761b17bdf3d982127a Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 17 Apr 2020 12:05:29 +0200 Subject: [PATCH 46/63] Fix errors --- app_pihole.md | 75 ++++++++++++++++++++++++++++++++++++++-- app_pihole_fr.md | 16 +++++---- contributordoc.md | 2 +- contributordoc_fr.md | 2 +- doc_markdown_guide_fr.md | 33 ++++++++++-------- 5 files changed, 101 insertions(+), 27 deletions(-) diff --git a/app_pihole.md b/app_pihole.md index 86ede826..cfb6e255 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -1,5 +1,74 @@ -===== Pihole ===== +# Pi-hole's logo Pi-hole -Homepage: https://pi-hole.net +[![Install Pi-hole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pihole) [![Integration level](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) -**Pi-hole®** Network-wide ad blocking via your own DNS server, with nice Performance And Statistics web page. +### Index + +- [Use Pi-Hole as DHCP server](#use-pi-hole-as-server-dhcp) + - [Configure Pi-Hole](#configure-pi-hole) + - [Configure my router](#configure-my-router) + - [Restore Network](#restore-network) +- [Useful links] [# Useful links] + +Pi-hole is a network-level ad blocker that acts as a DNS liar and possibly a DHCP3 server for use on a private network. It is designed to be installed on embedded devices with network capabilities, such as the Raspberry Pi, but can be used on other machines running Linux or in virtualized environments. + +## Using Pi-Hole as a DHCP server + +> **Warning, you should be aware that touching your DHCP could break your network. +In case your server is inaccessible, you will lose your dns resolution and IP address. +Thus, you would lose any connection to the internet and even the connection to your router.** + +> If you encounter this kind of problem, please read the section "How to restore my network". + +### Configuring Pi-hole + +There are 2 ways to configure Pi-hole to be used as your DHCP server. +- Either you can choose to use it when you install the application. +- Or you can activate the DHCP server afterwards in the "Settings" tab, part "Pi-hole DHCP Server". +In this second case, it may be preferable to force the server ip to a static address. + +### Configure my router + +Your router or your ISP's router has a DHCP server enabled by default. +If you keep this DHCP, along with Pi-hole's, you will have transparent conflicts between them. +The first DHCP server to respond will distribute its own ip and settings. +So you need to turn off your router's DHCP server and let Pi-hole manage your network. + +#### Why should I use Pi-hole's DHCP? + +By using Pi-hole's DHCP, you allow Pi-hole to give its dns configuration to each of your clients. This way, every request will be filtered by Pi-hole. + +Another case of using Pi-hole DHCP is if you have hairpinning problems (you can't connect to your server because its ip is your public ip, and your router doesn't allow this). +In this case, using Pi-hole's dns will allow you to connect to your server by its local address rather than its public address. + +### Restore the network + +> Oops! +Your Pi-hole server has crashed, and you don't have DHCP anymore. +Don't panic. We'll get through this. + +Use your favorite device on your desktop computer. +And first, get your network interface (usually `eth0`). +```bash +sudo ifconfig +``` + +Then change your ip to a static ip. +```bash +sudo ifconfig eth0 192.168.1.100 +``` + +Now you can connect to your router and reboot its DHCP server to use it again. +You can now remove your static ip and get a dynamic ip again. +```bash +sudo ifconfig eth0 0.0.0 && sudo dhclient eth0 +``` + +> Remember to turn off your router's DHCP if your server is running again. + +## Useful links + ++ Website: [WEBSITE](#) ++ Official documentation: [DOCUMENTATION](#) ++ Application software repository: [github.com - YunoHost-Apps/pihole](https://github.com/YunoHost-Apps/pihole_ynh) ++ Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/pihole/issues](https://github.com/YunoHost-Apps/pihole_ynh/issues) diff --git a/app_pihole_fr.md b/app_pihole_fr.md index 98e7e6bc..bafd85a7 100644 --- a/app_pihole_fr.md +++ b/app_pihole_fr.md @@ -1,12 +1,12 @@ # logo de Pi-hole Pi-hole -[![Installer Pi-hole avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pihole)[![Niveau d'intégration](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) +[![Installer Pi-hole avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pihole)[![Niveau d'intégration](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) -- [Utiliser Pi-Hole comme serveur DHCP](#utiliser-pi-Hole-comme-serveur-dhcp) +- [Utiliser Pi-Hole comme serveur DHCP](#utiliser-pi-hole-comme-serveur-dhcp) - [Configurer Pi-Hole](#configurer-pi-hole) - [Configurer mon routeur](#configurer-mon-routeur) - - [Restaurer le réseau](#restaurer-le-reseau) -- [Liens utiles](#quelques-liens-utiles) + - [Restaurer le réseau](#restaurer-le-réseau) +- [Liens utiles](#liens-utiles) Pi-hole est un bloqueur de publicité au niveau du réseau qui agit comme un DNS menteur et éventuellement un serveur DHCP3, destiné à être utilisé sur un réseau privé. Il est conçu pour être installé sur des périphériques intégrés dotés de capacités réseau, tels que le Raspberry Pi, mais il peut être utilisé sur d'autres machines exécutant Linux ou dans des environnements virtualisés. @@ -64,7 +64,9 @@ sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0 > N'oubliez pas d'éteindre le DHCP de votre routeur si votre serveur fonctionne à nouveau. -## Quelques liens utiles +## Liens utiles -+ Site officiel : [pi-hole.net](https://pi-hole.net) -+ Documentation Pi-Hole : [docs.pi-hole.net](https://docs.pi-hole.net/) + + Site web : [pi-hole.net (en)](https://pi-hole.net) + + Documentation officielle : [docs.pi-hole.net (en)](https://docs.pi-hole.net/) + + Dépôt logiciel de l'application : [github.com - YunoHost-Apps/pihole](https://github.com/YunoHost-Apps/pihole_ynh) + + Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/pihole/issues](https://github.com/YunoHost-Apps/pihole_ynh/issues) diff --git a/contributordoc.md b/contributordoc.md index 9d6a6212..7f117acb 100644 --- a/contributordoc.md +++ b/contributordoc.md @@ -2,7 +2,7 @@ * [General ways of contributing to YunoHost](/contribute) * [Writing documentation](/write_documentation) - * [Documentation wrinting guide](doc_writing_guide) + * [Documentation wrinting guide](/doc_writing_guide) * [markdown guide](/doc_markdown_guide) * [Propulser son code avec Git & GitHub](/doc_use_git) * [Chat rooms](/chat_rooms) diff --git a/contributordoc_fr.md b/contributordoc_fr.md index afcc9e9b..49691e01 100644 --- a/contributordoc_fr.md +++ b/contributordoc_fr.md @@ -2,7 +2,7 @@ * [Liste des façons de contribuer à YunoHost](/contribute) * [Écrire de la documentation](/write_documentation) - * [Guide de redaction de la documentation](doc_writing_guide) + * [Guide de redaction de la documentation](/doc_writing_guide) * [Guide markdown](/doc_markdown_guide) * [Propulser son code avec Git & GitHub](/doc_use_git) * [Salons de discussion](/chat_rooms) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index dcc12fca..d28ca94e 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -31,8 +31,8 @@ Pour taper un retour à la ligne sans créer de nouveau paragraphe, il est néce En rédigeant ça : ```markdown -Pour du texte en *italique il faut encadrer par un astérisque`*`* -Pour rédiger du **texte en gras par deux astérisques** +Pour du texte en *italique il faut encadrer par un astérisque* `*` +Pour rédiger du **texte en gras par deux astérisques** `**` On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` ``` @@ -53,11 +53,12 @@ Pour créer un lien vers un site hors de la documentation de YunoHost : s'affichera comme tel : [Texte à afficher](https://lelien.tld) -C'est identique pour les pages de la documentation, excepté que le lien est interne. Il renvoie au fichier du wiki, sans extension de langgue et de fichier (le `_fr.md`) : +C'est identique pour les pages de la documentation, excepté que le lien est interne. Il renvoie au fichier du wiki, sans extension de langue et de fichier (le `_fr.md`) : ```markdown [Page du wiki](/write_documentation) ``` +Le lien renverra vers la page avec la bonne configuration de langue si la page existe. [Page du wiki](/write_documentation) ### Créer des ancres @@ -94,7 +95,7 @@ Il est possible de faire un lien avec une image, exemple : ``` [![Logo Yunohost](/images/logo.png)](/write_documentation) -L'encart de *texte à afficher en cas d'impossibilité de chargement de l'image* n'est pas obligatoire mais fortement recommandé. +L'encart de *texte à afficher en cas d'impossibilité de chargement de l'image* entre les corchets dans le lien de l'image n'est pas obligatoire mais fortement recommandé. ## Formater une citation @@ -129,9 +130,9 @@ Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'e 1. liste 3 1. Liste 3a 1. Liste 3b - 3. Liste 3b1 - 3. Liste 3b2 - 3. Liste 3b3 + 7. Liste 3b1 + 7. Liste 3b2 + 7. Liste 3b3 4. Liste 1 4. Liste 2 4. liste 3 @@ -206,41 +207,43 @@ Pour créer un tableau, il faut utiliser la barre verticale `|` et les tirets `- | **Un tableau** | Une colonne | Une seconde | Autant que l'on veut | |:--------------:|:-----------:|:-----------:|:--------------------:| | Une ligne formatée | | Et du **texte en gras** | Ou en *italique* | -| D'autres lignes | |![une image](/images/cd.jpg) | [Ou un lien]( contributordoc) | +| D'autres lignes | |![une image](/images/cd.jpg) | [Ou un lien](/contributordoc) | ``` Ce qui afficherait ça : | **Un tableau** | Une colonne | Une seconde | Autant que l'on veut | |:--------------:|:-----------:|:-----------:|:--------------------:| | Une ligne formatée | | Et du **texte en gras** | Ou en *italique* | -| D'autres lignes | |![une image](/images/cd.jpg) | [Ou un lien]( contributordoc) | +| D'autres lignes | |![une image](/images/cd.jpg) | [Ou un lien](/contributordoc) | ## Bloc de codes Pour afficher du texte en brut, des `blocs de codes` peuvent être créer en utilisant l'accent grave `Alt Gr + è` : -````markdown -Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` +```markdown +Soit inline, par exemple pour mettre en valeur une touche comme 'Ctrl' ``` + ou directement en bloc. La seule différence est dans la quantité d'accents graves : -Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne +Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne Ce qui donnera au rendu : +``` +''' Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` - +''' ``` ou directement en bloc. La seule différence est dans la quantité d'accents graves : Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne -``` ## Liens utiles + La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) + Tutoriel Markdown sur [markdowntutorial.com (en)](https://markdowntutorial.com) -## Aller plus loin +## Aller plus loin De manière plus général, pour comprendre comment est formaté un texte il suffit juste d'inspecter le document source avec une application note. Ce n'est pas pour autant que le wiki de YunoHost pourra l'exploiter. Il existe bien d'autres possibilités d'utiliser la syntaxe markdown, n'hésitez pas à ajouter des fonctionnalités manquantes. Si vous avez observé des manques et/ou que vous avez des questions, contactez-nous sur [le forum](https://forum.yunohost.org) ou par message directe sur le salon IRC : **#yunohost** sur [irc.freenode.net](https://irc.freenode.net). From fb41e9c8a4fb6786326ab6b2be29234bfc32662d Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 17 Apr 2020 12:57:12 +0200 Subject: [PATCH 47/63] update --- app_pihole.md | 10 +++++----- doc_markdown_guide_fr.md | 23 +++++++++++------------ 2 files changed, 16 insertions(+), 17 deletions(-) diff --git a/app_pihole.md b/app_pihole.md index cfb6e255..bd7edc66 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -4,7 +4,7 @@ ### Index -- [Use Pi-Hole as DHCP server](#use-pi-hole-as-server-dhcp) +- [Using Pi-Hole as a DHCP server](#using-pi-hole-as-a-dhcp-server) - [Configure Pi-Hole](#configure-pi-hole) - [Configure my router](#configure-my-router) - [Restore Network](#restore-network) @@ -20,7 +20,7 @@ Thus, you would lose any connection to the internet and even the connection to y > If you encounter this kind of problem, please read the section "How to restore my network". -### Configuring Pi-hole +### Configure Pi-Hole There are 2 ways to configure Pi-hole to be used as your DHCP server. - Either you can choose to use it when you install the application. @@ -41,7 +41,7 @@ By using Pi-hole's DHCP, you allow Pi-hole to give its dns configuration to each Another case of using Pi-hole DHCP is if you have hairpinning problems (you can't connect to your server because its ip is your public ip, and your router doesn't allow this). In this case, using Pi-hole's dns will allow you to connect to your server by its local address rather than its public address. -### Restore the network +### Restore network > Oops! Your Pi-hole server has crashed, and you don't have DHCP anymore. @@ -68,7 +68,7 @@ sudo ifconfig eth0 0.0.0 && sudo dhclient eth0 ## Useful links -+ Website: [WEBSITE](#) -+ Official documentation: [DOCUMENTATION](#) ++ Website: [pi-hole.net](https://pi-hole.net) ++ Official documentation: [docs.pi-hole.net](https://docs.pi-hole.net/) + Application software repository: [github.com - YunoHost-Apps/pihole](https://github.com/YunoHost-Apps/pihole_ynh) + Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/pihole/issues](https://github.com/YunoHost-Apps/pihole_ynh/issues) diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index d28ca94e..59d0e4f4 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -38,8 +38,8 @@ On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` On peut lire ça : -Pour du texte en *italique il faut encadrer par un astérisque `*` * -Pour rédiger du **texte en gras par deux astérisques** +Pour du texte en *italique il faut encadrer par un astérisque* `*` +Pour rédiger du **texte en gras par deux astérisques** `**` On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~` ## Créer des liens @@ -69,7 +69,7 @@ Du texte qui sera ne sait même pas qu'il a une ancre ``` Ce qui s'affiche : -Du texte qui sera ne sait même pas qu'il a une ancre +Du texte qui sera ne sait même pas qu'il a une ancre Il ne reste plus qu'à désigner l'ancre au texte que l'on souhaite rendre interactif : @@ -77,7 +77,7 @@ Il ne reste plus qu'à désigner l'ancre au texte que l'on souhaite rendre inter [Mon titre qui renvoie](#nom-du-titre) ``` -[Mon titre qui renvoie](#nom-du-titre) +[Mon titre qui renvoie](#nomdelancre) ## Afficher des images @@ -158,7 +158,7 @@ On obtient : 3. Liste 5 4. liste 6 -### Listes non ordonnées +### Listes non ordonnées Pour créer une liste non ordonnée, il faut utiliser les symboles `*`, `+` ou `*`. Cela ne changera pas l'apparence du marqueur dans la restitution du texte. C'est l'incrémentation de la liste qui définira le visuel. Pour une meilleure lecture du texte brut, il peut être bien d'utiliser les différents symboles pour marquer l'incrémentation, mais c'est bien les trois espaces avant la sous-liste qui désigneront l'incrémentation. Comme tel : @@ -221,7 +221,7 @@ Ce qui afficherait ça : Pour afficher du texte en brut, des `blocs de codes` peuvent être créer en utilisant l'accent grave `Alt Gr + è` : ```markdown -Soit inline, par exemple pour mettre en valeur une touche comme 'Ctrl' +Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` ``` ou directement en bloc. @@ -230,19 +230,18 @@ Minimum trois accents graves en ouverture et fermeture de bloc et deux accent gr Ce qui donnera au rendu : -``` -''' Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` -''' -``` + +```markdown ou directement en bloc. La seule différence est dans la quantité d'accents graves : -Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne +Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne +``` ## Liens utiles + La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) - + Tutoriel Markdown sur [markdowntutorial.com (en)](https://markdowntutorial.com) + + Tutoriel Markdown sur [markdowntutorial.com](https://markdowntutorial.com) ## Aller plus loin From 6fbe1fa79370668c2de48b62d89b6f7154a9e1b6 Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 17 Apr 2020 13:04:15 +0200 Subject: [PATCH 48/63] Fix errors --- app_pihole.md | 2 +- doc_markdown_guide_fr.md | 18 +++++++++--------- doc_use_git.md | 10 ---------- doc_use_git_fr.md | 10 ---------- doc_writing_guide.md | 5 +---- doc_writing_guide_fr.md | 5 +---- 6 files changed, 12 insertions(+), 38 deletions(-) diff --git a/app_pihole.md b/app_pihole.md index bd7edc66..9333f479 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -8,7 +8,7 @@ - [Configure Pi-Hole](#configure-pi-hole) - [Configure my router](#configure-my-router) - [Restore Network](#restore-network) -- [Useful links] [# Useful links] +- [Useful links](#useful-links) Pi-hole is a network-level ad blocker that acts as a DNS liar and possibly a DHCP3 server for use on a private network. It is designed to be installed on embedded devices with network capabilities, such as the Raspberry Pi, but can be used on other machines running Linux or in virtualized environments. diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 59d0e4f4..0fd54bd3 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -130,9 +130,9 @@ Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'e 1. liste 3 1. Liste 3a 1. Liste 3b - 7. Liste 3b1 - 7. Liste 3b2 - 7. Liste 3b3 + 1. Liste 3b1 + 1. Liste 3b2 + 1. Liste 3b3 4. Liste 1 4. Liste 2 4. liste 3 @@ -148,9 +148,9 @@ On obtient : 1. liste 3 1. Liste 3a 1. Liste 3b - 3. Liste 3b1 - 3. Liste 3b2 - 3. Liste 3b3 + 1. Liste 3b1 + 1. Liste 3b2 + 1. Liste 3b3 4. Liste 1 4. Liste 2 4. liste 3 @@ -158,7 +158,7 @@ On obtient : 3. Liste 5 4. liste 6 -### Listes non ordonnées +### Listes non ordonnées Pour créer une liste non ordonnée, il faut utiliser les symboles `*`, `+` ou `*`. Cela ne changera pas l'apparence du marqueur dans la restitution du texte. C'est l'incrémentation de la liste qui définira le visuel. Pour une meilleure lecture du texte brut, il peut être bien d'utiliser les différents symboles pour marquer l'incrémentation, mais c'est bien les trois espaces avant la sous-liste qui désigneront l'incrémentation. Comme tel : @@ -231,13 +231,13 @@ Minimum trois accents graves en ouverture et fermeture de bloc et deux accent gr Ce qui donnera au rendu : Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` - +''' ```markdown ou directement en bloc. La seule différence est dans la quantité d'accents graves : Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne ``` - +''' ## Liens utiles + La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) diff --git a/doc_use_git.md b/doc_use_git.md index bc875f29..6c846bbd 100644 --- a/doc_use_git.md +++ b/doc_use_git.md @@ -6,8 +6,6 @@ It is of course possible to contribute directly to the YunoHost documentation, b To be able to send your contributions via GitHub, you need to have an account on GitHub, to create the account you will need a valid email address that you have access to. GitHub is a powerful tool with many features, the interface can be a little scary at first. You don't have to give your first and last names, you can use a nickname (when you register `Username`). -*/iframe video create a GitHub account /* - ## Fork the YunoHost documentation in your personal repository To fork the source code allows you to create a new branch of development of a software source code or in this case the source code of the documentation. By creating a new branch, this allows you to modify the code and add your contributions without altering the code of the `master' branch, which is the public release of the documentation. This allows you not to have to write down everything at once, but to do it in several steps. (Especially for contributions that require more time). @@ -16,8 +14,6 @@ Forking a project on GitHub is extremely simple, just click on the Fork button, In the title of the new repository, you will see where the repository comes from, in this case `YunoHost/doc`. ![Screenshots title and subtitle of the repository](/images/dug_fork_source.png) -*/iframe video forker source code GitHub /* - > **Point of vigilance !** > If you forge the repository of another contributor than yunohost, you'll get the same files. Except that when you send your changes, they will be sent to the contributor and not to the yunohost repository. The advantage is that it allows you to develop another branch created by the contributor and work with another person on an improvement before submitting it to the main repository. > It is not possible to have a fork from a contributor's repository and the original repository fork at the same time in your own account. @@ -26,8 +22,6 @@ In the title of the new repository, you will see where the repository comes from Once the repository is forked (copied), you will need to create a new development branch within your repository. It is through this branch that you will modify the files and thus propose improvements to the documentation. The fact that it is a new branch will allow you to make a Pull Request, i.e. a request to add your contributions to the `master' branch, which is the main documentation branch. The development rules on GitHub change depending on the developers of each repository, some have a testing branch in which to offer contributions. More information on what a branch on git-scm.com is: [Branching with Git - What a branch is](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). -*/iframe video edit files add contribution /* - ## Send your contribution by a Pull Request Create a Pull Request when you want to share your work with the other contributors and integrate it into the master repository (Yunohost's main repository). When publishing a Pull Request, commonly called PR, contributors will be able to amend, comment, add, correct your contribution before it is fully integrated into the repository. @@ -46,7 +40,3 @@ Using the power of Git to work on your personal computer means you don't have to ## Some resources elsewhere on the net to go further - [Managing your code with Git and GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - [Git User Interface - git-scm.com](https://git-scm.com/download/gui/linux) - -*/ To do/* -*/Add videos explanation/* - Add videos explanation/* -*/Add ## Correct and inspect contributions /* diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 3590179b..8cdab1c3 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -6,8 +6,6 @@ Il est bien sûr possible de contribuer directement sur la documentation de Yuno Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur GitHub, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. GitHub est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utiliser un pseudonyme (lors de l'inscription `Username`). -*/iframe video creer compte GitHub /* - ## Forker la documentation de YunoHost dans votre dépôt personel Forker le code source permet de créer une nouvelle branche de développement d'un code source de logiciel ou dans le cas présent, le code source de la documentation. En créant une nouvelle branche, cela vous permet de modifier le code et d'ajouter vos contributions sans altérer le code de la branche `master` qui est le rendu public de la documentation. Ce qui vous permet de ne pas devoir tout marquer mais le faire en plusieurs étapes. (Notamment pour les contributions demandant plus de temps de travail). @@ -17,8 +15,6 @@ Forker un projet sur GitHub est extrêmement simple, il suffit ce cliquer sur le Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dépôt, dans le cas présent `YunoHost/doc` ![Capture d'écran titre et sous-titre du dépot](/images/dug_fork_source.png) -*/iframe video forker code source GitHub /* - > **Point de vigilance !** > Si vous forkez le dépôt d'un autre contributeur que yunohost, vous aurez les mêmes fichiers. Sauf que quand vous enverrez vos modifications, elles seront envoyées au contributeur et non au dépôt yunohost. L'avantage est que ça vous permet de développer une autre branche créee par le contributeur et ainsi travailler avec une autre personne à une amélioration avant proposition au dépôt principal. > Il n'est pas possible d'avoir un fork du dépot d'un contributeur et le fork dépôt d'origine au même moment dans votre propre dépôt. @@ -27,8 +23,6 @@ Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dép Une fois le dépôt forker (copié), il faudra créer une nouvelle branche de développement au sein de votre dépôt. C'est à travers cette branche que vous allez modifier les fichiers et ainsi proposer des améliorations de la documentation. Le fait que ce soit une nouvelle branche vous permettra par la suite de faire une Pull Request, c'est à dire une demande d'ajout de vos contributions au sein de la branche `master` qui est la branche principale de la documentation. Les règles de développement sur GitHub change selon les développeurs de chaque dépôt, certains ont une branche testing dans laquelle il faut proposer les contributions. Plus d'informations sur qu'est une branche sur git-scm.com : [Les branches avec Git - Ce qu'est une branche](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). -*/iframe video modifier fichiers ajouter contribution /* - ## Envoyer votre contribution par une Pull Request Faire une Pull Request correspond au moment ou vous souahitez partager votre travaille avec le reste des contributeurs⋅trices et l'intégrer au dépot master (dépôt principale de Yunohost). Lors de la publication d'un Pull Request, couramment nommé PR, les contributeurs⋅trices pourront amender, commenter, ajouter, corriger votre contribution avant intégration complète au dépot. @@ -47,7 +41,3 @@ Utiliser la puissance de Git et ainsi travailler sur son ordinateur personnel, p ## Quelques ressources ailleurs sur le net pour aller plus loin - [Gérer son code avec Git et GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - [Interface utilisateurs·trices de Git - git-scm.com](https://git-scm.com/download/gui/linux) - -*/ To do/* -*/Ajouter vidéos explicative - Add videos explication/* -*/Ajouter ## Corriger et inspecter les contributions /* diff --git a/doc_writing_guide.md b/doc_writing_guide.md index 14d64208..13e87128 100644 --- a/doc_writing_guide.md +++ b/doc_writing_guide.md @@ -4,10 +4,7 @@ Add a one-click install button (such as https://yunohost.org/#/app_piwigo_fr) and a button on the application integration level. - -Classification of available applications by tags (genre, Git, association management, emails, etc.). - -*/Definition of a license to distribute the documentation, but which one? Permissive or not (CC BY-SA)/* +Classification of available applications by tags (genre, Git, association management, emails, etc). ## Some typical and general uses (writing framework) diff --git a/doc_writing_guide_fr.md b/doc_writing_guide_fr.md index f62f3598..d210baf6 100644 --- a/doc_writing_guide_fr.md +++ b/doc_writing_guide_fr.md @@ -4,10 +4,7 @@ Ajouter un bouton installer en un clique (comme par exemple : https://yunohost.org/#/app_piwigo_fr) et un bouton sur le niveau d'intégration de l'application. - -Classement des applications disponibles par tags (genre, Git, gestion associations, courriels, etc.). - -*/Définition d'une license de diffusion de la documentation, mais laquelle ? Permissive ou non (CC BY-SA)/* +Classement des applications disponibles par tags (genre, Git, gestion associations, courriels, etc). ## Quelques usages types et d'ordres général (trame de rédaction) From d8a43cbd2516ab7a4a2cb2edd51d00f3cbe66cf4 Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 17 Apr 2020 13:26:50 +0200 Subject: [PATCH 49/63] Fix doc markdown guide english --- doc_markdown_guide.md | 258 +++++++++++++++++++++++++++++++++++++-- doc_markdown_guide_fr.md | 21 ++-- 2 files changed, 259 insertions(+), 20 deletions(-) diff --git a/doc_markdown_guide.md b/doc_markdown_guide.md index b42deefe..928315e5 100644 --- a/doc_markdown_guide.md +++ b/doc_markdown_guide.md @@ -1,16 +1,252 @@ -# Markdown Guide +# Guide Markdown -Markdown is a markup language from 2004, with many add-ons supporting its function and existence. This guide explores the possibilities and formatting of the language in the context of YunoHost documentation, and not the Markdown language on its own. +Markdown is a markup language created in 2004, many add-ons developing the possibilities of this language exist. The objective of this guide is to aim for the exhaustiveness of the possibilities of this formatting language within the framework of the YunoHost documentation and not Markdown languages in general. -Markdown allows formatting of text using tags, in human-readable format; even with formatting. Outside of plaintext editors, a number of specific programs exist. (Markdown on [framalibre.org](https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is easy to deal with. +Markdown allows text to be formatted using tags, it allows *human* reading of the text; even with formatting. Even if only one notepad is needed there are many markdowns software (Markdown on [framalibre.org](https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is relatively easy to use. -## The different title levels +## The different levels of titles + +By writing titles as follows: +```Markdown +# Level 1 title +## Level 2 title +### Level 3 title +#### Level 4 title +### Level 5 title +#### Level 6 title +``` + +They appear like this: +# Level 1 title +## Level 2 title +### Level 3 title +#### Level 4 title +### Level 5 title +#### Level 6 title + +## Formatting in paragraphs + +To type a line break without creating a new paragraph, it is necessary to type **two consecutive spaces**. Otherwise, the text will continue in a row respecting the general constraints of the page style. + +By writing this : -Write headlines like this: ```markdown -# Level 1 -## Level 2 -### Level 3 -#### Level 4 -##### Level 5 -###### Level 6 +For text in *italic you have to frame it with an asterisk* `*` +To write **bold text by two asterisks** `**` +You can also ~~bar the text~~ by framing it with two tildes `~` +``` + +It reads like this: + +For text in *italic you have to frame it with an asterisk* `*` +To write **bold text by two asterisks** `**` +You can also ~~bar the text~~ by framing it with two tildes `~` + +## Create links ## + +To create a link to a site outside of the YunoHost documentation: + +```markdown +[Text to display](https://lelien.tld) +``` + +will be displayed as such: +[Text to display](https://lelien.tld) + +It is the same for the documentation pages, except that the link is internal. It refers to the wiki file, without language and file extension (the `_en.md`) : +```markdown +[Wiki Page](/write_documentation) +``` + +The link will return to the page with the correct language setting if the page exists. +Wiki page](/write_documentation) + +### Create anchors +An anchor allows you to make a link to a specific point in a page, that's how the indexes at the top of the page work. To create an anchor, you need to insert code at the anchor location in the following form : + +```markdown +Text that will be doesn't even know it has an anchor. +``` + +What's displayed is: +Text that will be doesn't even know it has an anchor. + +It is also possible to return an anchor directly to the title, noting the link in lower case with `-`s instead of spaces. +All that remains is to designate the anchor to the text you want to make interactive: + +```markdown +[My Anchor Returns to Lists] [#AnchorName] +[My Anchor that refers to the title of the tables](#the tables) +``` + +[My Anchor Returns to Lists] [#AnchorName] +[My Anchor that refers to the title of the tables](#the tables) + +## Displaying images + +To display images, the principle is the same as for links, except that a `!` is added before the text to be displayed, which is considered here as the text to be displayed if the image cannot be loaded. A description of the image is appropriate. + +```markdown +[Yunohost Logo](/images/logo.png) +``` +[Yunohost Logo](/images/logo.png) + + +It is possible to make a link with an image, for example : +```markdown +[! [Yunohost Logo](/images/logo.png)](/write_documentation) +``` +[! [Yunohost Logo](/images/logo.png)](/write_documentation) + +The insert of *text to be displayed if the image cannot be loaded* between the brackets in the image link is not mandatory but strongly recommended. + +## Format a quote + +Quotes are used to highlight a statement made by another person, the wiki itself manages the way it is highlighted. Markdown uses a closing chevron, this symbol: `>`, to announce a quote. Just add it before the quote, as such: + +```markdown +>First level quotation text +>which can be formatted in different lines + +>> And a second quote +>> with double rafters +``` +Will be displayed : + +>First level quotation text +>which can be formatted in different lines + +>> And a second quote +>> with double rafters + +## Lists + +Lists allow to display a series of texts in an easy presentation, this is how indexes such as the [contributing documentation](contributordoc) page are written. + +### Ordered lists + +The ordered lists can be incremented as much as you wish, it is not necessary to give the right match to the number. It is possible to write down with `1.` and put in three spaces to mark the increment. For a better understanding of the plain text, it may be fine to use the numbers in ascending order to mark the increment, but it is the three consistent `spaces' before the sub-list that will mark the increment. + +```markdown +1. List 1 +1. List 2 +1. list 3 + 1. List 3a + 1. List 3b + 1. List 3b1 + 1. List 3b2 + 1. List 3b3 + 1. List 1 + 1. List 2 + 1. list 3 +1. List 4 +1. List 5 +1. list 6 +``` + +You get: + +1. List 1 +1. List 2 +1. list 3 + 1. List 3a + 1. List 3b + 1. List 3b1 + 1. List 3b2 + 1. List 3b3 + 1. List 1 + 1. List 2 + 1. list 3 +5. List 4 +3. List 5 +4. list 6 + +### Unordered lists + +To create an unordered list, use the symbols `*`, `+` or `*`. This will not change the appearance of the marker in the text output. It is the incrementing of the list that will define the visual. For a better reading of the plain text, it may be good to use the different symbols to mark the increment, but it is the three spaces before the sub-list that will indicate the increment. +As such: +```markdown ++ List 1 ++ List 2 ++ list 3 + - List 3a + - List 3b + * List 3b1 + * List 3b2 + * List 3b3 + + List 1 + + List 2 + + list 3 +- List 4 +* List 5 ++ list 6 +``` + +This will read: ++ List 1 ++ List 2 ++ list 3 + - List 3a + - List 3b + * List 3b1 + * List 3b2 + * List 3b3 + + List 1 + + List 2 + + list 3 +- List 4 +* List 5 ++ list 6 + +## Tables + +To create an array, use the vertical bar `|` and dashes `--`. It is mandatory to add a line of dashes under the first line of the table. There is no constraint in the size of the table. It is possible to format the array with the `:` in the second row of the array, three options are available: + +| Left aligned column | Centered column | Right aligned column | +|:-------------------------|:---------------:|-------------------------:| +|`:-----` | `:----:` | `-----:` | + +```markdown +|| One table | | One column | | One second | | As many as you want | +|:--------------:|:-----------:|:-----------:|:--------------------:| +| | And formatted line | | And bold text | | Or *italic* | +| More lines | |! [An image](/images/cd.jpg) | [Or a link](/contributordoc) | +``` +Which would say this: + +| ? A table ? ? A column ? ? A second ? ? As many as you want ? +|:--------------:|:-----------:|:-----------:|:--------------------:| +| | And formatted line | | And bold text | | Or *italic* | +| More lines | |! [An image](/images/cd.jpg) | [Or a link](/contributordoc) | + +## Code block + +To display plain text, `blocks of code' can be created using the grave accent `Alt Gr + è` : + +```markdown +Either inline, for example to highlight a key like `Ctrl`. +``` + +or directly as a block. +The only difference is in the amount of bass accents: +At least three low pitched accents at the opening and closing of the block and two low pitched accents that frame the piece of text to be formatted in a line. + +Which will give the rendering: + +Either inline, for example to highlight a key like `Ctrl`. +''' +```markdown +or directly as a block. +The only difference is in the amount of bass accents: +At least three low pitched accents at the opening and closing of the block and two low pitched accents that frame the piece of text to be formatted in a line. +``` +''' + +## Useful links + + + The documentation of the original Markdown language: [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) + + Markdown Tutorial on [markdowntutorial.com](https://markdowntutorial.com) + +## Going further ## + +In a more general way, to understand how a text is formatted just inspect the source document with a note application. This does not mean that the YunoHost wiki will be able to exploit it. There are many other possibilities to use markdown syntax, feel free to add missing features. If you've noticed some missing features and/or have questions, please contact us on [the forum](https://forum.yunohost.org) or by direct message on the IRC room: **#yunohost** on [irc.freenode.net](https://irc.freenode.net). diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 0fd54bd3..12e6071f 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -71,13 +71,16 @@ Du texte qui sera ne sait même pas qu'il a une ancre Ce qui s'affiche : Du texte qui sera ne sait même pas qu'il a une ancre +Il est aussi possible de directement renvoyer une ancre au titre, en notant le lien en minuscule avec des `-` à la place des espaces. Il ne reste plus qu'à désigner l'ancre au texte que l'on souhaite rendre interactif : ```markdown -[Mon titre qui renvoie](#nom-du-titre) +[Mon ancre qui renvoie vers les listes](#nomdelancre) +[Mon ancre qui renvoie vers le titre des tableaux](#les-tableaux) ``` -[Mon titre qui renvoie](#nomdelancre) +[Mon ancre qui renvoie vers les listes](#nomdelancre) +[Mon ancre qui renvoie vers le titre des tableaux](#les-tableaux) ## Afficher des images @@ -122,7 +125,7 @@ Les listes permettent d'afficher une suite de textes dans une présentation faci ### Listes ordonnées -Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'est pas obligé de donner la bonne correspondance au nombre. Il est possible de noter avec des `1.` comme des `7.` et installer trois espaces pour marquer l'incrémentation. Pour une meilleure compréhension du texte brut, il peut être bien d'utiliser les chiffres de manières croissantes pour marquer l'incrémentation, mais c'est bien les trois `espaces` conséquents avant la sous-liste qui désigneront l'incrémentation. +Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'est pas obligé de donner la bonne correspondance au nombre. Il est possible de noter avec des `1.` et installer trois espaces pour marquer l'incrémentation. Pour une meilleure compréhension du texte brut, il peut être bien d'utiliser les chiffres de manières croissantes pour marquer l'incrémentation, mais c'est bien les trois `espaces` conséquents avant la sous-liste qui désigneront l'incrémentation. ```markdown 1. Liste 1 @@ -133,9 +136,9 @@ Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'e 1. Liste 3b1 1. Liste 3b2 1. Liste 3b3 - 4. Liste 1 - 4. Liste 2 - 4. liste 3 + 1. Liste 1 + 1. Liste 2 + 1. liste 3 1. Liste 4 1. Liste 5 1. liste 6 @@ -151,9 +154,9 @@ On obtient : 1. Liste 3b1 1. Liste 3b2 1. Liste 3b3 - 4. Liste 1 - 4. Liste 2 - 4. liste 3 + 1. Liste 1 + 1. Liste 2 + 1. liste 3 5. Liste 4 3. Liste 5 4. liste 6 From 94cba7fa6bd3a9b1414c3bab1e52ddc56c00ce97 Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 17 Apr 2020 13:46:04 +0200 Subject: [PATCH 50/63] Fix markdown guide --- doc_markdown_guide.md | 54 ++++++++++++++++++++-------------------- doc_markdown_guide_fr.md | 6 ++--- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/doc_markdown_guide.md b/doc_markdown_guide.md index 928315e5..c30ef925 100644 --- a/doc_markdown_guide.md +++ b/doc_markdown_guide.md @@ -2,7 +2,7 @@ Markdown is a markup language created in 2004, many add-ons developing the possibilities of this language exist. The objective of this guide is to aim for the exhaustiveness of the possibilities of this formatting language within the framework of the YunoHost documentation and not Markdown languages in general. -Markdown allows text to be formatted using tags, it allows *human* reading of the text; even with formatting. Even if only one notepad is needed there are many markdowns software (Markdown on [framalibre.org](https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is relatively easy to use. +Markdown allows text to be formatted using tags, it allows *human* reading of the text; even with formatting. Even if only one notepad is needed there are many markdowns software (Markdown on [framalibre.org (fr)](https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is relatively easy to use. ## The different levels of titles @@ -12,8 +12,8 @@ By writing titles as follows: ## Level 2 title ### Level 3 title #### Level 4 title -### Level 5 title -#### Level 6 title +##### Level 5 title +###### Level 6 title ``` They appear like this: @@ -21,8 +21,8 @@ They appear like this: ## Level 2 title ### Level 3 title #### Level 4 title -### Level 5 title -#### Level 6 title +##### Level 5 title +###### Level 6 title ## Formatting in paragraphs @@ -42,7 +42,7 @@ For text in *italic you have to frame it with an asterisk* `*` To write **bold text by two asterisks** `**` You can also ~~bar the text~~ by framing it with two tildes `~` -## Create links ## +## Create links To create a link to a site outside of the YunoHost documentation: @@ -53,13 +53,13 @@ To create a link to a site outside of the YunoHost documentation: will be displayed as such: [Text to display](https://lelien.tld) -It is the same for the documentation pages, except that the link is internal. It refers to the wiki file, without language and file extension (the `_en.md`) : +It is the same for the documentation pages, except that the link is internal. It refers to the wiki file, without language and file extension (the `_fr.md`) : ```markdown [Wiki Page](/write_documentation) ``` The link will return to the page with the correct language setting if the page exists. -Wiki page](/write_documentation) +[Wiki page](/write_documentation) ### Create anchors An anchor allows you to make a link to a specific point in a page, that's how the indexes at the top of the page work. To create an anchor, you need to insert code at the anchor location in the following form : @@ -75,28 +75,28 @@ It is also possible to return an anchor directly to the title, noting the link i All that remains is to designate the anchor to the text you want to make interactive: ```markdown -[My Anchor Returns to Lists] [#AnchorName] -[My Anchor that refers to the title of the tables](#the tables) +[My Anchor Returns to Lists](#anchorname) +[My Anchor that refers to the title of the tables](#tables) ``` -[My Anchor Returns to Lists] [#AnchorName] -[My Anchor that refers to the title of the tables](#the tables) +[My Anchor Returns to Lists](#anchorame) +[My Anchor that refers to the title of the tables](#tables) ## Displaying images To display images, the principle is the same as for links, except that a `!` is added before the text to be displayed, which is considered here as the text to be displayed if the image cannot be loaded. A description of the image is appropriate. ```markdown -[Yunohost Logo](/images/logo.png) +![Yunohost Logo](/images/logo.png) ``` -[Yunohost Logo](/images/logo.png) +![Yunohost Logo](/images/logo.png) It is possible to make a link with an image, for example : ```markdown -[! [Yunohost Logo](/images/logo.png)](/write_documentation) +[![Yunohost Logo](/images/logo.png)](/write_documentation) ``` -[! [Yunohost Logo](/images/logo.png)](/write_documentation) +[![Yunohost Logo](/images/logo.png)](/write_documentation) The insert of *text to be displayed if the image cannot be loaded* between the brackets in the image link is not mandatory but strongly recommended. @@ -121,7 +121,7 @@ Will be displayed : ## Lists -Lists allow to display a series of texts in an easy presentation, this is how indexes such as the [contributing documentation](contributordoc) page are written. +Lists allow to display a series of texts in an easy presentation, this is how indexes such as the [contributing documentation](/contributordoc) page are written. ### Ordered lists @@ -161,7 +161,7 @@ You get: 3. List 5 4. list 6 -### Unordered lists +### Unordered lists To create an unordered list, use the symbols `*`, `+` or `*`. This will not change the appearance of the marker in the text output. It is the incrementing of the list that will define the visual. For a better reading of the plain text, it may be good to use the different symbols to mark the increment, but it is the three spaces before the sub-list that will indicate the increment. As such: @@ -203,21 +203,21 @@ This will read: To create an array, use the vertical bar `|` and dashes `--`. It is mandatory to add a line of dashes under the first line of the table. There is no constraint in the size of the table. It is possible to format the array with the `:` in the second row of the array, three options are available: | Left aligned column | Centered column | Right aligned column | -|:-------------------------|:---------------:|-------------------------:| +|:--------------------|:---------------:|---------------------:| |`:-----` | `:----:` | `-----:` | ```markdown -|| One table | | One column | | One second | | As many as you want | -|:--------------:|:-----------:|:-----------:|:--------------------:| +| **One table** | One column | One second | As many as you want | +|:-------------:|:----------:|:----------:|:-------------------:| | | And formatted line | | And bold text | | Or *italic* | -| More lines | |! [An image](/images/cd.jpg) | [Or a link](/contributordoc) | +| More lines | |![An image](/images/cd.jpg) | [Or a link](/contributordoc) | ``` Which would say this: -| ? A table ? ? A column ? ? A second ? ? As many as you want ? -|:--------------:|:-----------:|:-----------:|:--------------------:| +| **One table** | One column | One second | As many as you want | +|:-------------:|:----------:|:----------:|:-------------------:| | | And formatted line | | And bold text | | Or *italic* | -| More lines | |! [An image](/images/cd.jpg) | [Or a link](/contributordoc) | +| More lines | |![An image](/images/cd.jpg) | [Or a link](/contributordoc) | ## Code block @@ -244,9 +244,9 @@ At least three low pitched accents at the opening and closing of the block and t ## Useful links - + The documentation of the original Markdown language: [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) + + The documentation of the original Markdown language: [daringfireball.net/projects/markdown](https://daringfireball.net/projects/markdown/) + Markdown Tutorial on [markdowntutorial.com](https://markdowntutorial.com) -## Going further ## +## Going further In a more general way, to understand how a text is formatted just inspect the source document with a note application. This does not mean that the YunoHost wiki will be able to exploit it. There are many other possibilities to use markdown syntax, feel free to add missing features. If you've noticed some missing features and/or have questions, please contact us on [the forum](https://forum.yunohost.org) or by direct message on the IRC room: **#yunohost** on [irc.freenode.net](https://irc.freenode.net). diff --git a/doc_markdown_guide_fr.md b/doc_markdown_guide_fr.md index 12e6071f..ded2225d 100644 --- a/doc_markdown_guide_fr.md +++ b/doc_markdown_guide_fr.md @@ -65,11 +65,11 @@ Le lien renverra vers la page avec la bonne configuration de langue si la page e Une ancre permet de faire un lien vers un point précis dans une page, c'est comme ça que fonctionnent les index en haut de page. Pour créer une ancre, il faut insérer du code à l'endroit de l'ancre sous la forme suivante : ```markdown -Du texte qui sera ne sait même pas qu'il a une ancre +Du texte qui sera ne sait même pas qu'il a une ancre ``` Ce qui s'affiche : -Du texte qui sera ne sait même pas qu'il a une ancre +Du texte qui sera ne sait même pas qu'il a une ancre Il est aussi possible de directement renvoyer une ancre au titre, en notant le lien en minuscule avec des `-` à la place des espaces. Il ne reste plus qu'à désigner l'ancre au texte que l'on souhaite rendre interactif : @@ -121,7 +121,7 @@ S'affichera : ## Les listes -Les listes permettent d'afficher une suite de textes dans une présentation facile, c'est ainsi que sont rédiger les index tels que celui de la page de la [documentation contributeur](contributordoc). +Les listes permettent d'afficher une suite de textes dans une présentation facile, c'est ainsi que sont rédiger les index tels que celui de la page de la [documentation contributeur](/contributordoc). ### Listes ordonnées From 3e48726f0f6245f3b55fed9c1b8d8aeacdff48aa Mon Sep 17 00:00:00 2001 From: Plumf Date: Fri, 17 Apr 2020 22:49:52 +0200 Subject: [PATCH 51/63] Fix Jaxom99 observation --- doc_use_git.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc_use_git.md b/doc_use_git.md index 6c846bbd..14323aaf 100644 --- a/doc_use_git.md +++ b/doc_use_git.md @@ -7,7 +7,7 @@ To be able to send your contributions via GitHub, you need to have an account on You don't have to give your first and last names, you can use a nickname (when you register `Username`). ## Fork the YunoHost documentation in your personal repository -To fork the source code allows you to create a new branch of development of a software source code or in this case the source code of the documentation. By creating a new branch, this allows you to modify the code and add your contributions without altering the code of the `master' branch, which is the public release of the documentation. This allows you not to have to write down everything at once, but to do it in several steps. (Especially for contributions that require more time). +To fork the source code allows you to create a new branch of development of a software source code or in this case the source code of the documentation. By creating a new branch, this allows you to modify the code and add your contributions without altering the code of the `master` branch, which is the public release of the documentation. This allows you not to have to write down everything at once, but to do it in several steps. (Especially for contributions that require more time). Forking a project on GitHub is extremely simple, just click on the Fork button, this will create a new repository on your GitHub account. ![Screenshot GitHub fork button screenshot](/images/dug_fork.png) @@ -19,11 +19,11 @@ In the title of the new repository, you will see where the repository comes from > It is not possible to have a fork from a contributor's repository and the original repository fork at the same time in your own account. ## Modify and add your contribution -Once the repository is forked (copied), you will need to create a new development branch within your repository. It is through this branch that you will modify the files and thus propose improvements to the documentation. The fact that it is a new branch will allow you to make a Pull Request, i.e. a request to add your contributions to the `master' branch, which is the main documentation branch. The development rules on GitHub change depending on the developers of each repository, some have a testing branch in which to offer contributions. +Once the repository is forked (copied), you will need to create a new development branch within your repository. It is through this branch that you will modify the files and thus propose improvements to the documentation. The fact that it is a new branch will allow you to make a Pull Request, i.e. a request to add your contributions to the `master` branch, which is the main documentation branch. The development rules on GitHub change depending on the developers of each repository, some have a testing branch in which to offer contributions. More information on what a branch on git-scm.com is: [Branching with Git - What a branch is](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). ## Send your contribution by a Pull Request -Create a Pull Request when you want to share your work with the other contributors and integrate it into the master repository (Yunohost's main repository). When publishing a Pull Request, commonly called PR, contributors will be able to amend, comment, add, correct your contribution before it is fully integrated into the repository. +Create a Pull Request when you want to share your work with the other contributors and integrate it into the master repository (YunoHost's main repository). When publishing a Pull Request, commonly called PR, contributors will be able to amend, comment, add, correct your contribution before it is fully integrated into the repository. ## Track your contribution and take into account feedback from contributors When you've already create a Pull Request (PR), changes to your development branch in the Git repository will automatically be added to the PR. This doesn't require any additional action. You can also include proposed changes from contributors, who, when they audit the code, may find errors or new, better wording. @@ -33,7 +33,7 @@ YunoHost has a specific Git repository to collect issues: [github.com/YunoHost/i An issue, also called a ticket, is an identified problem or a development wish; in this case for documentation, but it is valid for any software repository. Within the framework of the YunoHost documentation it will be mainly proposed issues for the development of the documentation, the identified problems being easily correctable. ## Going further with Git and working on his workstation -Using the power of Git to work on your personal computer means you don't have to create a `commit' each time you save modified documentation pages. It also allows you to use tools and software that make it easier to distinguish between tags used in a documentation page. +Using the power of Git to work on your personal computer means you don't have to create a `commit` each time you save modified documentation pages. It also allows you to use tools and software that make it easier to distinguish between tags used in a documentation page. - Online resource: [docs.microsoft.com - Setting up a Git repository locally for documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) From acb69665dfc05499ac7c1f62d16b8ed2859a65ca Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:28:59 +0200 Subject: [PATCH 52/63] Update contributordoc_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- contributordoc_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributordoc_fr.md b/contributordoc_fr.md index df6bb942..3c2d9d5b 100644 --- a/contributordoc_fr.md +++ b/contributordoc_fr.md @@ -3,7 +3,7 @@ * [Liste des façons de contribuer à YunoHost](/contribute) * [Écrire de la documentation](/write_documentation) * [Guide de redaction de la documentation](/doc_writing_guide) - * [Guide markdown](/doc_markdown_guide) + * [Guide Markdown](/doc_markdown_guide) * [Propulser son code avec Git & GitHub](/doc_use_git) * [Salons de discussion](/chat_rooms) * Packaging d'application From 219ea0c71fb802224a45e6d67d84c73088110602 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:29:10 +0200 Subject: [PATCH 53/63] Update doc_writing_guide.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide.md b/doc_writing_guide.md index 13e87128..fdd26a0b 100644 --- a/doc_writing_guide.md +++ b/doc_writing_guide.md @@ -4,7 +4,7 @@ Add a one-click install button (such as https://yunohost.org/#/app_piwigo_fr) and a button on the application integration level. -Classification of available applications by tags (genre, Git, association management, emails, etc). +Classification of available applications by tags (genre, Git, association management, e-mails, etc). ## Some typical and general uses (writing framework) From 6b6830a1b14358389e5fbca0c5a5296f05643883 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:29:23 +0200 Subject: [PATCH 54/63] Update doc_writing_guide.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_writing_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_writing_guide.md b/doc_writing_guide.md index fdd26a0b..8ebd0d08 100644 --- a/doc_writing_guide.md +++ b/doc_writing_guide.md @@ -21,7 +21,7 @@ Classification of available applications by tags (genre, Git, association manage 1. An administration part of the application. 1. A part on limitations related to YunoHost. 1. A part on desktop clients (if any). A link to different third-party applications if there are several (possible link to the applications catalgue [framalibre.org](https://framalibre.org)) or a link to the page about desktop applications if official applications are provided. - 1. A part with : + 1. A part with: - the link to the official site - the link to the documentation - Links to the YunoHost package and issues From 5e3907f47caf582eff444cecb103f88721910fd9 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:29:36 +0200 Subject: [PATCH 55/63] Update app_pihole.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- app_pihole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app_pihole.md b/app_pihole.md index 9333f479..6faa5aa5 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -38,7 +38,7 @@ So you need to turn off your router's DHCP server and let Pi-hole manage your ne By using Pi-hole's DHCP, you allow Pi-hole to give its dns configuration to each of your clients. This way, every request will be filtered by Pi-hole. -Another case of using Pi-hole DHCP is if you have hairpinning problems (you can't connect to your server because its ip is your public ip, and your router doesn't allow this). +Another case of using Pi-hole DHCP is if you have hairpinning problems (you can't connect to your server because its IP is your public IP, and your router doesn't allow this). In this case, using Pi-hole's dns will allow you to connect to your server by its local address rather than its public address. ### Restore network From bb8a743c5d68d992737686cc20fdbc5598af3c66 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:29:48 +0200 Subject: [PATCH 56/63] Update app_pihole.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- app_pihole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app_pihole.md b/app_pihole.md index 6faa5aa5..2b3a62ef 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -10,7 +10,7 @@ - [Restore Network](#restore-network) - [Useful links](#useful-links) -Pi-hole is a network-level ad blocker that acts as a DNS liar and possibly a DHCP3 server for use on a private network. It is designed to be installed on embedded devices with network capabilities, such as the Raspberry Pi, but can be used on other machines running Linux or in virtualized environments. +Pi-hole is a network-level ad blocker that acts as a DNS layer and possibly a DHCP3 server for use on a private network. It is designed to be installed on embedded devices with network capabilities, such as the Raspberry Pi, but can be used on other machines running Linux or in virtualised environments. ## Using Pi-Hole as a DHCP server From 702190f27efc1f054dec506183b57f263dab885e Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:30:00 +0200 Subject: [PATCH 57/63] Update app_pihole.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- app_pihole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app_pihole.md b/app_pihole.md index 2b3a62ef..7a3e985d 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -25,7 +25,7 @@ Thus, you would lose any connection to the internet and even the connection to y There are 2 ways to configure Pi-hole to be used as your DHCP server. - Either you can choose to use it when you install the application. - Or you can activate the DHCP server afterwards in the "Settings" tab, part "Pi-hole DHCP Server". -In this second case, it may be preferable to force the server ip to a static address. +In this second case, it may be preferable to force the server IP to a static address. ### Configure my router From 3da49e25332f246aa7f7f2405384029134eff5e4 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:30:12 +0200 Subject: [PATCH 58/63] Update doc_use_git_fr.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- doc_use_git_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_use_git_fr.md b/doc_use_git_fr.md index 8cdab1c3..c5001956 100644 --- a/doc_use_git_fr.md +++ b/doc_use_git_fr.md @@ -3,7 +3,7 @@ Il est bien sûr possible de contribuer directement sur la documentation de YunoHost, mais ce n'est pas la manière la plus pratique de le faire tant pour le/la contributeur·trice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de Yunohost en utilisant l'outil [Git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge Git qui héberge et stocke le code source de YunoHost ainsi que sa documentation. ## Création d'un compte sur github.com -Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur GitHub, pour créer le compte vous aurez besoin d'une adresse email valide à laquelle vous avez accès. GitHub est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. +Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire avoir un compte sur GitHub, pour créer le compte vous aurez besoin d'une adresse e-mail valide à laquelle vous avez accès. GitHub est un outil puissant qui propose de nombreuses fonctionnalités, l'interface peut être un peu effrayant au début. Vous n'êtes pas obligé·ée de donner vos noms et prénoms, vous pouvez utiliser un pseudonyme (lors de l'inscription `Username`). From 543219db0c2bf10caa87b0d1ca4360ab1782a33b Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:30:22 +0200 Subject: [PATCH 59/63] Update app_pihole.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- app_pihole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app_pihole.md b/app_pihole.md index 7a3e985d..d9856a66 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -59,7 +59,7 @@ sudo ifconfig eth0 192.168.1.100 ``` Now you can connect to your router and reboot its DHCP server to use it again. -You can now remove your static ip and get a dynamic ip again. +You can now remove your static IP and get a dynamic IP again. ```bash sudo ifconfig eth0 0.0.0 && sudo dhclient eth0 ``` From a7344f8c88b50d2d5f2da40d44aacf6490b57d4a Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:30:32 +0200 Subject: [PATCH 60/63] Update app_pihole.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- app_pihole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app_pihole.md b/app_pihole.md index d9856a66..3ebb0e1c 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -31,7 +31,7 @@ In this second case, it may be preferable to force the server IP to a static add Your router or your ISP's router has a DHCP server enabled by default. If you keep this DHCP, along with Pi-hole's, you will have transparent conflicts between them. -The first DHCP server to respond will distribute its own ip and settings. +The first DHCP server to respond will distribute its own IP and settings. So you need to turn off your router's DHCP server and let Pi-hole manage your network. #### Why should I use Pi-hole's DHCP? From 933df61643cba67561ae0e22faece35bbb11e668 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:30:44 +0200 Subject: [PATCH 61/63] Update app_pihole.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- app_pihole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app_pihole.md b/app_pihole.md index 3ebb0e1c..3366a39b 100644 --- a/app_pihole.md +++ b/app_pihole.md @@ -53,7 +53,7 @@ And first, get your network interface (usually `eth0`). sudo ifconfig ``` -Then change your ip to a static ip. +Then change your IP to a static one. ```bash sudo ifconfig eth0 192.168.1.100 ``` From 5568477f931442ccb00b63c2fb383ab6f2f0032c Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:30:53 +0200 Subject: [PATCH 62/63] Update contributordoc.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- contributordoc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributordoc.md b/contributordoc.md index 2b6a8f7b..045a7055 100644 --- a/contributordoc.md +++ b/contributordoc.md @@ -3,7 +3,7 @@ * [General ways of contributing to YunoHost](/contribute) * [Writing documentation](/write_documentation) * [Documentation wrinting guide](/doc_writing_guide) - * [markdown guide](/doc_markdown_guide) + * [Markdown guide](/doc_markdown_guide) * [Propulser son code avec Git & GitHub](/doc_use_git) * [Chat rooms](/chat_rooms) * Application packaging From bf6241bc1f77dbb397c59547600a3733887284c4 Mon Sep 17 00:00:00 2001 From: Plumf <45500657+Plumf@users.noreply.github.com> Date: Sun, 19 Apr 2020 19:31:20 +0200 Subject: [PATCH 63/63] Update app_writing_guide.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Allan Nordhøy --- app_writing_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app_writing_guide.md b/app_writing_guide.md index edd0f3db..46f2d222 100644 --- a/app_writing_guide.md +++ b/app_writing_guide.md @@ -5,7 +5,7 @@ ### Index - [Configuration](#configuration) -- [Limitations with YunoHost](#limitations-with-yunohost) +- [Limitations of YunoHost](#limitations-with-yunohost) - [Customer Applications](#customer-applications) - [Useful links](#useful-links)