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)