Vous êtes nouveau sur Developpez.com ? Créez votre compte ou connectez-vous afin de pouvoir participer !

Vous devez avoir un compte Developpez.com et être connecté pour pouvoir participer aux discussions.

Vous n'avez pas encore de compte Developpez.com ? Créez-en un en quelques instants, c'est entièrement gratuit !

Si vous disposez déjà d'un compte et qu'il est bien activé, connectez-vous à l'aide du formulaire ci-dessous.

Identifiez-vous
Identifiant
Mot de passe
Mot de passe oublié ?
Créer un compte

L'inscription est gratuite et ne vous prendra que quelques instants !

Je m'inscris !

Contribuez à la FAQ de la rubrique Hardware

Le , par LittleWhite

0PARTAGES

8  0 
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 !

Une erreur dans cette actualité ? Signalez-le nous !

Avatar de chrtophe
Responsable Systèmes https://www.developpez.com
Le 14/06/2020 à 11:05
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.
1  0 
Avatar de JML19
Expert éminent sénior https://www.developpez.com
Le 14/06/2020 à 11:54
Bonjour

Je trouve que c'est compliqué.

Il faudrait faire un fichier texte qui serait traduit par des spécialistes de ce langage.
0  0 
Avatar de LittleWhite
Responsable 2D/3D/Jeux https://www.developpez.com
Le 15/06/2020 à 10:04
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.
0  0 
Avatar de chrtophe
Responsable Systèmes https://www.developpez.com
Le 15/06/2020 à 19:41
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.
0  0 
Avatar de LittleWhite
Responsable 2D/3D/Jeux https://www.developpez.com
Le 15/06/2020 à 20:02
Citation Envoyé par chrtophe Voir le message
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.
0  0 
Avatar de chrtophe
Responsable Systèmes https://www.developpez.com
Le 16/06/2020 à 7:40
Quelle partie est une régression ?
Sur le système d'origine, l'ajout d'une question la faisait directement apparaitre dans l'arborescence,

Lors de l'édition d'un fichier, vous avez un éditeur, avec un bouton/onglet de preview.
Sur le système d'origine, il y avait la barre d’icône pour automatiquement mettre du texte en gras, en italique, un hyperlien, etc, plus pratique pour les non programmeurs.
Mais nous sommes sur un forum d'informaticiens, c'est pas la fin du monde.
0  0 
Avatar de JML19
Expert éminent sénior https://www.developpez.com
Le 16/06/2020 à 9:52
Bonjour

Autant cela m'était facile de manipuler le code Assembleur 8086 et 68000 avant mon Burn-Out, autant cela devient difficile pour moi de le faire travailler longtemps.

Mon cerveau a gardé sa puissance, mais il ne tient plus la distance.
0  0 
Avatar de chrtophe
Responsable Systèmes https://www.developpez.com
Le 17/06/2020 à 8:27
C'est pas de l'assembleur non plus.
Pour faire du gras en html : <b>gras</b> (b pour bold)
en bbcode : [ B ] gras [ /B ] (espaces ajoutés pour que l'éditeur de message n'interprète pas le bbcode)
en markdown : **gras**

J'ai mis une seule balise, pour le lien. A savoir que c'est de l'habillage, j'aurais pu m'en passer, le texte brut est le plus important. Dans une semaine, je ne saurais plus comment faire, car du Markdown j'en fais pas tous les jours, mais je retrouverais l'info très rapidement. J'ai pas lu la doc, mais cherché sur Google, j'ai trouvé tout de suite. Et pourtant c'est expliqué dans la doc qu'il faut donc lire si on est pas autonome là-dessus.

La "difficulté" est plutôt de comprendre qu'il faut créer un fichier, pour y stocker l'élément. En gros, chaque section/paragraphe est contenu dans un dossier, qui va contenir un fichier par question (sous-paragraphe).
C'est expliqué de façon concise.

En cas de difficultés, nous serons là pour aider. Il faut juste ne pas résister au changement, c'est d'ailleurs un très bon exercice pour le cerveau. Cela n'empêche pas de donner un avis.
0  0 
Avatar de LittleWhite
Responsable 2D/3D/Jeux https://www.developpez.com
Le 18/06/2020 à 8:33
Citation Envoyé par chrtophe Voir le message
Sur le système d'origine, l'ajout d'une question la faisait directement apparaitre dans l'arborescence,
Dans l'ancien (le plus vieux format), c'était du XML, donc l'édition n'était pas possible par les utilisateurs lambda.
Ensuite, il y a les FAQ ouverte (nouveau système). Dans ce cas là, seul les responsables/ou membre spécifié peuvent voir les QR à accepter/intégrer. Par contre, tous le monde peut ajouter une QR. Cela veut donc dire, que lorsque vous ajoutez une QR, vous ne la voyez pas non plus (sauf si vous êtes responsables ).
C'est pour ça, que je ne vois pas de régression sur ce point.

Pour le reste, le but est que les gens puissent contribuer facilement. Comme je l'ai dit, si le format Markdown est embêtant, alors on peut toujours répondre à cette discussion pour proposer une QR. L'équipe (moi, notamment) intégrera la QR dans la FAQ.
0  0 
Avatar de chrtophe
Responsable Systèmes https://www.developpez.com
Le 18/06/2020 à 9:19
Par contre, tous le monde peut ajouter une QR. Cela veut donc dire, que lorsque vous ajoutez une QR, vous ne la voyez pas non plus (sauf si vous êtes responsables
c'est vrai que je n'y avait pas pensé. Ça en reste une pour moi, qui suis resp et ne voit donc plus les questions, mais pas bien grave.

En tout cas j'ai testé le système en prod, et ça marche.
0  0