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

Correction ortho

Browse source
This commit is contained in:
FrancoisA 2020-04-26 02:08:43 +02:00
parent 1401f67e80
commit 13b82fcaa2
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
doc_writing_guide_fr.md
View file

@ -1,29 +1,29 @@
# Guide de rédaction de la documentation des applications # 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). 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` + 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. Logo (dimension 80 pixels de hauteur) + titre de niveau 1.
1. Bouton installer en un clique, Niveau d'intégration pour chaque type de processeur. 1. Bouton installer en un clic, 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. Un index en tête de documentation avec renvoi vers l'ensemble des chapitres de la documentation.
1. Une présentation général de l'application et de sa fonction. 1. Une présentation générale de l'application et de sa fonction.
2. UNe partie configuration de l'application. 2. Une partie configuration de l'application.
1. Une partie administration de l'application. 1. Une partie administration de l'application.
1. Une partie sur les limitation liés à YunoHost. 1. Une partie sur les limitations liées à 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 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 : 1. Une partie avec :
- le lien vers le site officiel - 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 - Les liens vers le package de YunoHost et issues
Trame pour la rédaction des pages de documentations : [ici](/app_writing_guide) 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.
1. Documenter les applications au travail (marqué : work) niveau 8/7/6. 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. 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.