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

Various typos & caps

Browse source
This commit is contained in:
ericgaspar 2020-04-23 22:28:25 +02:00
parent 597461a034
commit 1277dfedf8
3 changed files with 32 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
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·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 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`).
## 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`).
## 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 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)
![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 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 cela 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).
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 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 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épôt.
## 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.
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.

18
docker.md
View file

@ -2,8 +2,8 @@
<div class="alert alert-danger">
<b>
Yunohost doesn't support Docker officially since issues with versions 2.4+.
In question, YunoHost 2.4+ doesn't work anymore on Docker
YunoHost doesn’t support Docker officially since issues with versions 2.4+.
In question, YunoHost 2.4+ doesn’t work anymore on Docker
because YunoHost requires systemd and Docker has chosen to not support it natively (and
there are other problems link to the firewall and services).
</b>
@ -11,13 +11,13 @@ there are other problems link to the firewall and services).
## Community images
However, community images exist and are available on Docker Hub :
However, community images exist and are available on Docker Hub:
* AMD64 (classic)
* https://hub.docker.com/r/domainelibre/yunohost3/ (Yunohost v3)
* https://hub.docker.com/r/domainelibre/yunohost3/ (YunoHost v3)
* I386 (old computers)
* https://hub.docker.com/r/domainelibre/yunohost3-i386/ (Yunohost v3)
* ARMV7 (raspberry pi 2/3 ...)
* https://hub.docker.com/r/domainelibre/yunohost3-arm/ (Yunohost v3)
* ARMV6 (raspberry pi 1)
* https://hub.docker.com/r/tuxalex/yunohost-armv6/ (old yunohost version)
* https://hub.docker.com/r/domainelibre/yunohost3-i386/ (YunoHost v3)
* ARMV7 (Raspberry Pi 2/3 ...)
* https://hub.docker.com/r/domainelibre/yunohost3-arm/ (YunoHost v3)
* ARMV6 (Raspberry Pi 1)
* https://hub.docker.com/r/tuxalex/yunohost-armv6/ (old yunoHost version)

16
docker_fr.md
View file

@ -2,8 +2,8 @@
<div class="alert alert-danger">
<b>
Yunohost ne supporte plus officiellement Docker depuis les problèmes rencontrés avec la version 2.4+.
En cause, YunoHost dépend désormait de systemd et docker a décidé qu'ils ne le
YunoHost ne supporte plus officiellement Docker depuis les problèmes rencontrés avec la version 2.4+.
En cause, YunoHost dépend désormait de systemd et docker a décidé qu’ils ne le
supporteraient pas nativement (et il y a d'autres problèmes liés au firewall et aux
services).
</b>
@ -14,10 +14,10 @@ services).
Cependant il existe des images communautaires disponibles sur Docker Hub :
* AMD64 (classique)
* https://hub.docker.com/r/domainelibre/yunohost3/ (Yunohost v3)
* https://hub.docker.com/r/domainelibre/yunohost3/ (YunoHost v3)
* I386 (anciens pc)
* https://hub.docker.com/r/domainelibre/yunohost3-i386/ (Yunohost v3)
* ARMV7 (raspberry pi 2/3 ...)
* https://hub.docker.com/r/domainelibre/yunohost3-arm/ (Yunohost v3)
* ARMV6 (raspberry pi 1)
* https://hub.docker.com/r/tuxalex/yunohost-armv6/ (ancienne version de Yunohost)
* https://hub.docker.com/r/domainelibre/yunohost3-i386/ (YunoHost v3)
* ARMV7 (Raspberry Pi 2/3 ...)
* https://hub.docker.com/r/domainelibre/yunohost3-arm/ (YunoHost v3)
* ARMV6 (Raspberry Pi 1)
* https://hub.docker.com/r/tuxalex/yunohost-armv6/ (ancienne version de YunoHost)