YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1270 from webafrancois/contribadoc

Browse source 
Ajout d'une page lstu_fr et corrections ortho
This commit is contained in:
Alexandre Aubin 2020-04-26 18:15:17 +02:00 • committed by GitHub
commit 7ef5ef664c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 101 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
app_lstu_fr.md Normal file
View file

@ -0,0 +1,22 @@
# <img src="/images/lstu_logo.svg" width="80px" alt="logo de LSTU"> LSTU
[![Installer LSTU avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=lstu) [![Niveau d'intégration](https://dash.yunohost.org/integration/lstu.svg)](https://dash.yunohost.org/appci/app/lstu)
### Index
- [Limitations avec YunoHost](#limitations-avec-yunohost)
- [Liens utiles](#liens-utiles)
LSTU est l'acronyme de "Let's shorten that URL" et est un raccourcisseur d'URL. Il permet de réduire la taille et de personnaliser une URL et de générer en même temps un flashcode associé. Vous pouvez ainsi relayer une URL plus courte dans des SMS, sur des publications papier ou des affiches. Il propose aussi une API permettant de générer ces liens à partir d'appel d'autres applications. Une extension de navigateur vous permet aussi de raccourcir n'importe quelle URL en un clic.
## Limitations avec YunoHost
Pas de limitations connues.
## Liens utiles
+ Site web : [lstu.fr](https://lstu.fr)
+ Documentation officielle : [Page Wiki sur Framagit](https://framagit.org/fiat-tux/hat-softwares/lstu/-/wikis/home)
+ Dépôt logiciel de l'application : [github.com - Yunohost-Apps/lstu-ynh](https://github.com/YunoHost-Apps/lstu_ynh)
+ Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/lstu_ynh/issues](https://github.com/YunoHost-Apps/lstu_ynh/issues)

39
app_piwigo_fr.md
View file

@ -1,30 +1,35 @@
## <img src="https://yunohost.org/images/piwigo.png">
# <img src="/images/piwigo_logo.png" width="80px" alt="logo de Piwigo"> Piwigo
[![Installer Piwigo avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=piwigo) [![Niveau d'intégration](https://dash.yunohost.org/integration/piwigo.svg)](https://dash.yunohost.org/appci/app/piwigo)
### Index
- [Liens utiles](#liens-utiles)
[Piwigo](http://piwigo.org) est un logiciel de galerie photo pour le web, bâti par une communauté active d'utilisateurs et de développeurs.
[Piwigo](http://piwigo.org) est un logiciel de galerie photos pour le web, bâti par une communauté active d'utilisateurs et de développeurs.
Les extensions rendent Piwigo facilement personnalisable. Cerise sur le gâteau, Piwigo est libre et gratuit.
[![Installer Piwigo avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=piwigo)
En plus des [fonctionnalités principales](http://piwigo.org/basics/features) de Piwigo, ce paquet propose également :
* une intégration avec le système de gestion des utilisateurs et le SSO de Yunohost :
* installation privée : limitée aux utilisateurs de YunoHost
* installation publique :
* SSO pour les utilisateurs YunoHost
* permet de gérer l'accès à d'autres utilisateurs, et mode invité possible
* de permettre à un utilisateur d'être administrateur (réglage lors de l'installation)
![](http://piwigo.org/screenshots/homepage/piwigo-batch-manager.png)
## Fonctionnalités
En plus des [fonctionnalités principales](http://piwigo.org/basics/features) de Piwigo, ce paquet propose également:
* une intégration avec le système de gestion des utilisateurs et le SSO de Yunohost :
* installation privée : limitée aux utilisateurs de YunoHost
* installation publique :
* SSO pour les utilisateurs YunoHost
* permet de gérer l'accès à d'autres utilisateurs, et mode invité possible
* de permettre à un utilisateur d'être administrateur (réglage lors de l'installation)
## Liens
* Rapport de bug: https://github.com/YunoHost-Apps/piwigo_ynh/issues
* Site web Piwigo : http://piwigo.org/
## Liens utiles
+ Site web : [Site Piwigo](https://piwigo.org)
+ Documentation officielle : [Documentation](https://piwigo.org/doc/doku.php)
+ Dépôt logiciel de l'application : [ (Dépôt logiciel de l'application :)
+ Dépôt logiciel de l'application : [github.com - YunoHost-Apps/piwigo](https://github.com/YunoHost-Apps/piwigo_ynh)
+ Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/piwigo/issues](https://github.com/YunoHost-Apps/piwigo_ynh/issues)

26
app_wallabag2_fr.md
View file

@ -1,9 +1,9 @@
## <img src="https://yunohost.org/images/Logo-wallabag-svg.svg">
## <img src="/images/wallabag_logo.svg"> Wallabag
[Wallabag](https://www.wallabag.org/) est une application de lecture différée : elle permet simplement d’archiver une page web en ne conservant que le contenu. Les éléments superflus (menus, publicités, etc.) sont supprimés.
Sont disponibles: une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et même sur liseuse (PocketBook / Kobo).
Sont disponibles : une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et même sur liseuse (PocketBook / Kobo).
[![Installer avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2)
@ -11,20 +11,20 @@ Sont disponibles: une interface web, des add-ons pour navigateurs (Firefox / Chr
En plus des fonctionnalités principales de Wallabag, ce paquet propose également:
* Une intégration avec le système de gestion des utilisateurs et le SSO de Yunohost - e.g. un bouton de déconnexion
* De permettre à un utilisateur d'être administrateur (réglage lors de l'installation)
* Un import asynchrone utilisant Redis (à activer dans les *Paramètres Internes*). L'import via RabbitMQ n'est pas (encore ?) supporté.
* Une intégration avec le système de gestion des utilisateurs et le SSO de Yunohost - e.g. un bouton de déconnexion
* De permettre à un utilisateur d'être administrateur (réglage lors de l'installation)
* Un import asynchrone utilisant Redis (à activer dans les *Paramètres Internes*). L'import via RabbitMQ n'est pas (encore ?) supporté.
### Liens
* Rapport de bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues
* Site web de Wallabag: https://www.wallabag.org/
* Documentation de Wallabag: https://doc.wallabag.org/ (fr/en/it/de)
* [Demo vidéo](https://player.vimeo.com/video/167435064)
----
### Mettre à niveau depuis la v1.x
* Rapport de bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues
* Site web de Wallabag: https://www.wallabag.org/
* Documentation de Wallabag: https://doc.wallabag.org/ (fr/en/it/de)
* [Demo vidéo](https://player.vimeo.com/video/167435064)
----
### Mettre à niveau depuis la v1.x
La mise à niveau depuis le paquet Yunohost de [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) demande une opération manuelle, c'est pourquoi un nouveau paquet est fournit.
Pour le processus de migration, merci de vous référer à [la documentation officiel de Wallabag](https://doc.wallabag.org/fr/user/import/wallabagv1.html).

4
app_writing_guide_fr.md
View file

@ -17,11 +17,11 @@
## 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.*
**Explication des limitations actuelles en utilisation de 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* |
| Nom de l'application | Plateforme | Multi-comptes | Autres réseaux supportés | Play Store | F-Droid | Apple Store | *Autres* |
|-----------------------|------------|---------------|-------------------------|------------|---------|-------------|----------|
| | | | | | | | |

32
doc_markdown_guide_fr.md
View file

@ -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 <a name="nomancre"></a>
Du texte qui ne sait même pas qu'il a une ancre <a name="nomancre"></a>
```
Ce qui s'affiche :
Du texte qui sera ne sait même pas qu'il a une ancre <a name="nomancre"></a>
Du texte qui ne sait même pas qu'il a une ancre <a name="nomancre"></a>
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 :
@ -98,11 +98,11 @@ 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* entre les corchets dans le lien 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 crochets dans le lien 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 :
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
@ -121,11 +121,11 @@ 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édigés 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.` 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 pratique d'utiliser les chiffres de manière croissante pour marquer l'incrémentation, mais ce sont bien les trois `espaces` conséquents avant la sous-liste qui désigneront l'incrémentation.
```markdown
1. Liste 1
@ -139,9 +139,9 @@ Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'e
1. Liste 1
1. Liste 2
1. liste 3
1. Liste 4
1. Liste 5
1. liste 6
5. Liste 4
3. Liste 5
4. liste 6
```
On obtient :
@ -163,7 +163,7 @@ On obtient :
### Listes non ordonnées<a name="nomdelancre"></a>
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.
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 pratique d'utiliser les différents symboles pour marquer l'incrémentation, mais ce sont bien les trois espaces avant la sous-liste qui désigneront l'incrémentation.
Comme tel :
```markdown
+ Liste 1
@ -200,7 +200,7 @@ Ce qui affichera :
## 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 :
Pour créer un tableau, il faut utiliser la barre verticale `|` (appelé 'pipe') et les tirets `-`. Il est obligatoire d'ajouter une ligne de tirets 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 |
|:-------------------------|:---------------:|-------------------------:|
@ -212,7 +212,7 @@ Pour créer un tableau, il faut utiliser la barre verticale `|` et les tirets `-
| 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 :
Ce qui affichera ça :
| **Un tableau** | Une colonne | Une seconde | Autant que l'on veut |
|:--------------:|:-----------:|:-----------:|:--------------------:|
@ -221,7 +221,7 @@ Ce qui afficherait ça :
## Bloc de codes
Pour afficher du texte en brut, des `blocs de codes` peuvent être créer en utilisant l'accent grave `Alt Gr + è` :
Pour afficher du texte en brut, des `blocs de code` peuvent être créés en utilisant l'accent grave `Alt Gr + è` :
```markdown
Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl`
@ -229,7 +229,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é 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 accents graves qui encadrent le morceau de texte à formater dans une ligne
Ce qui donnera au rendu :
@ -238,7 +238,7 @@ 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 accents graves qui encadrent le morceau de texte à formater dans une ligne
```
&#39;&#39;&#39;
## Liens utiles
@ -248,4 +248,4 @@ Minimum trois accents graves en ouverture et fermeture de bloc et deux accent gr
## 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).
De manière plus générale, 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 direct sur le salon IRC : **#yunohost** sur [irc.freenode.net](https://irc.freenode.net).

24
doc_use_git_fr.md
View file

@ -1,37 +1,37 @@
# Propulser une contribution avec Git
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·rice 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 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`).
Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire d'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 effrayante 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`).
## Forker la documentation de YunoHost dans votre dépôt personel
## Forker la documentation de YunoHost dans votre dépôt personnel
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 de 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)
> **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.
> Si vous forkez le dépôt d'un·e autre contributeur·rice 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éée par le·la contributeur·rice 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·e contributeur·rice 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).
Une fois le dépôt forké (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 changent 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 ce 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).
## 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.
Faire une Pull Request correspond au moment où vous souhaitez partager votre travail avec le reste des contributeurs⋅rices et l'intégrer au dépot master (dépôt principal de Yunohost). Lors de la publication d'une Pull Request, couramment nommée PR, les contributeurs⋅rices 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)
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.
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 corrigeables.
## 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.

28
doc_writing_guide_fr.md
View file

@ -1,29 +1,29 @@
# Guide de rédaction de la documentation des applications
## Pages de documentations utilisateurs.trices / administrateurs⋅trices
## Page de documentation utilisateurs·rices / administrateurs⋅rices
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.
Ajouter un bouton installer en un clic (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).
## Quelques usages types et d'ordres général (trame de rédaction)
## Quelques usages types et d'ordre 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).
+ Lorsqu'un lien renvoie 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
### Trame générale documentation applications
1. Logo (dimension 80 pixels de hauteurs) + titre de niveau 1.
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. Logo (dimension 80 pixels de hauteur) + titre de niveau 1.
1. Bouton installer en un clic, Niveau d'intégration pour chaque type de processeur.
1. Un index en tête de documentation avec renvoi vers l'ensemble des chapitres de la documentation.
1. Une présentation générale de l'application et de sa fonction.
2. Une partie configuration de l'application.
1. Une partie administration de l'application.
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. Une partie sur les limitations liées à YunoHost.
1. Une partie sur les clients desktop (si il en existe). Lien vers différentes applications tierces si il en existe plusieurs (lien possible avec le catalogue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des applications officielles sont fournies.
1. Une partie avec :
- le lien vers le site officiel
- le lien vers la documentation
- le lien vers la documentation officielle
- Les liens vers le package de YunoHost et issues
Trame pour la rédaction des pages de documentations : [ici](/app_writing_guide)
@ -33,4 +33,4 @@ Trame pour la rédaction des pages de documentations : [ici](/app_writing_guide)
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épôt de l'application concerné vers la page de documentation.
1. Faire une PR sur le dépôt de l'application concernée vers la page de documentation.