Discussion :

[LittleWhite]

Bonjour à tous,

Si vous visitez la FAQ de la rubrique Hardware, vous allez rapidement vous rendre compte que la FAQ possède peu de contenu et que les questions/réponses en place ne sont pas toutes jeunes.

Aujourd'hui, nous vous donnons la possibilité de corriger ce retard, et ce facilement. Et pour la première fois, nous vous proposons d'éditer la FAQ en passant par GitHub et le format MarkDown. En effet, tout est disponible sur ce dépôt et le travail a déjà commencé !

Pour contribuer, il y a plusieurs possibilités :

• éditer directement les questions/réponses sur le site GitHub ;
• éditer dans votre éditeur préféré en utilisant Git ;
• créer des "issues" pour indiquer quels sont les éléments à ajouter.
• répondre à cette discussion, ne serait-ce qu'en indiquant les questions que vous aimeriez voir dans la FAQ.

Les questions/réponses s'écrivent au format MarkDown. Pour ajouter une question/réponse, il suffit d'ajouter un fichier .md dans la section adéquate.
Il est possible d'ajouter une section (et des sous sections).

L'ordre des fichiers déterminent l'ordre des questions/réponses et des sections dans la FAQ.

En bref, toute contribution est bienvenue ! N'hésitez pas à dire ce qu'il manque, ce qui n'est pas assez précis et à écrire vos propres questions/réponses.
Aussi, n'hésitez pas à dire ce qu'il y a améliorer dans le processus de contribution. Est-ce que cette méthode pour plaît, ou qu'est ce qui ne vous attrait pas ?


À bientôt !

[Christophe]

J'ai fait quelques modifs via ce système.

C'est un peu déroutant, de par l'utilisation de Markdown (bien qu'expliqué)

Pour ceux non familier avec les process de type github. Il faut comprendre que vous proposez des modifs, et quelles ne seront pas visibles avant validation, idem pour les rajout de questions. C'est un peu chiant pour la navigation surtout si l'on souhaite revenir sur une entrée.

pour rajouter des entrées, il faut aller dans les sous-dossiers (exemple :faq-content/section-002-002 pour la section processeur).
Pour rajouter une entrée, il faut créer un nouveau fichier. En essayant de respecter la nomenclature si possible (histoire de donner moins de boulot au mainteneur principal)

En cas d'ajout d'entrées, le sommaire est modifié automatiquement ? (je suppose que oui).

Il vous faudra créer un compte sur github en plus de votre compte DVP.

[JML19]

Bonjour

Je trouve que c'est compliqué.

Il faudrait faire un fichier texte qui serait traduit par des spécialistes de ce langage.

[LittleWhite]

Bonjour,

Merci pour vos retours.

Les modifications de chrtophe sont intégrées dans la FAQ et la FAQ a été mise à jour : https://hardware.developpez.com/faq/. Merci beaucoup .

Il faudrait faire un fichier texte qui serait traduit par des spécialistes de ce langage.

Le langage Markdown n'est, je crois (d'après moi), pas si compliqué que cela. En réalité, chrtophe n'a utilisé que l'intégration des URL, qui se fait avec cette syntaxe :

Voici un [lien](www.developpez.com)

Le mot lien, sera le lien (souligné en bleu, cliquable). Et l'URL en question suit, et est entre parenthèses.

Pour le reste du format de la QR, il suffisait de copier l'entête :
[code]---
createDate: 2020-06-14
lastUpdateDate: 2020-06-14
author: Chrtophe
keywords: POE, Power Over Ethernet
---

# FAQ Hardware pour developpez.com

## Qu'est-ce que le POE ?[/quote]
Sachant que cette dernière ligne (avec les deux #), c'est la question de la QR.

Bref, pour le reste, il n'y a que du texte à écrire.

Il faudrait faire un fichier texte qui serait traduit par des spécialistes de ce langage.

Après, comme dit dans le message d'ouverture/d'annonce, vous pouvez très bien proposer vos QR ici même. Je les traduirai .

En cas d'ajout d'entrées, le sommaire est modifié automatiquement ? (je suppose que oui).

Pas pour le moment. Mais je l'ai mis à jour.

[Christophe]

Ca c'est une régression par rapport à l'ancien système. Après c'est pas non plus un travail de ouf.

Le langage Markdown n'est, je crois (d'après moi), pas si compliqué que cela. En réalité, chrtophe n'a utilisé que l'intégration des URL

oui, et j'ai juste googlelisé pour voir comment ça marchait.
C'est sur que sur github, il n'y a pas d'éditeur wysiwyg comme l'éditeur de messages ici-même pour écrire en Markdown.

C'est un peu comme le bbcode, exemple pour mettre du texte en gras, il faut le mettre entre ** (exemple **texte en gras**)
il y a un lien explicatif.

[LittleWhite]

Ca c'est une régression par rapport à l'ancien système. Après c'est pas non plus un travail de ouf.

Quelle partie est une régression ?

C'est sur que sur github, il n'y a pas d'éditeur wysiwyg comme l'éditeur de messages ici-même pour écrire en Markdown.

Lors de l'édition d'un fichier, vous avez un éditeur, avec un bouton/onglet de preview.