Manuel simplfié pour la prise en main du système Debian GNU/Linux
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

5.3 KiB

Guide de contribution pour les cahiers du débutant

Un guide en forme de FAQ pour contribuer aux cahiers du débutant...

Vous ne trouvez pas votre bonheur ? Posez votre question en ouvrant un ticket sur le dépôt git, elle sera intégrée, avec sa réponse, dans ce FAQ

bonne lecture

Fork or not fork ?

Comment contribuer, concrêtement ?

  • à la “git” : prévenir de l’intention sur un ticket pour éviter les conflits de modifications, forker le dépôt, modifier, proposer un merge.
  • à la main :
    • ouvrir un ticket sur git avec la modification à apporter, ou
    • me contacter par mail sur contact’alabase’arpinux.org avec la modif dans le mail, ou un .diff, ou une bonne blague, ou le tout...

Pourquoi des lignes de 80~90 caractères ?

Les sources des cahiers sont rédigées en Markdown, langage extrêmement pratique car il peut être exporté en de nombreux autres formats (PDF, html, ePub...) mais aussi, et j’en viens à la réponse, peut être lu verbatim, c’est à dire, sans outil particulier, juste avec un terminal.

Il se trouve qu’un terminal s’ouvre par défaut (en général) avec 80 colonnes. Donc le fait d'écrire en Markdown avec des lignes de 80~90 caractères facilite grandement la lecture directe des sources.

Pourquoi des images JPG en 96dpi de 900px maxi ?

Les images en JPG car elles sont généralement plus légères.
Les images en 96dpi car le PDF produit est en 96dpi. si les images sont en résolution trop faible, elles apparaîtront réduites, si elles ont une résolution trop forte, elles apparaîtront zoomées.

Les images en 900 px maxi pour la version html, histoire d’avoir une cohérence graphique et pas des images de toutes les tailles

Oui, on pourrait réduire toutes les images en 500px maxi (la largeur, en gros du PDF), mais dans ce cas, les images pour la version html seront réduites (dommage) et il vaut mieux laisser pandoc/LaTeX optimiser les images à la bonne taille pour le PDF.

certains logos sont en 300dpi pourtant ...

Certains logos ne servent que pour la version html et n’ont pas besoin d'être configurés en 96dpi.

Pourquoi pas des images perso ?

Les cahiers doivent, le plus possible, présenter des interfaces par défaut, afin d’aider le nouveau venu à se repérer face à son propre environnement. Je conseille l’installation en VBOX pour avoir un système vierge de modifications et de données personnelles.

Pourquoi tester la construction PDF entre chaque modification ?

Pour la mise en page. Après chaque modification des sources, il faut tester les modifications afin de vérifier qu’elles n’aient pas provoquées de saut de page ou de décallage.

Sur les cahiers, je tente le plus possible de rassembler sur une même page, le titre, l’image et l’explication. Il faut donc être vigilant sur la mise en page PDF et ne pas ajouter deux mots pour faire joli et risquer de gâcher la mise en page du reste du chapitre.

Des images classées et numérotées ?

Pour faciliter la recherche et la mise à jour des images, elles sont organisées en sous-dossiers, un pour chaque chapitre, et numérotées par ordre d’apparition dans les sources.

Images superflues ... bande-dessinées ... smileys ??

Oui, certaines images sont inutiles à la compréhension de la notion présente sur la page... mais les cahiers du débutant tentent de ne pas rebuter le nouveau venu, alors un peu de smiley et d’humour ne peuvent pas nuire à l’apprentissage :)

Commentaires avant ou après les images ?

... ça dépend ...
Il faut suivre la norme “titre + image + explication” sur la même page autant que possible. Donc à tester lorsque vous désirez modifier une explication.

Modification des titres et liens internes

Attention : les cahiers sont parsemés de liens internes (ancres) permettant une navigation fluide entre les sections. Les liens internes renvoient aux titres des chapitres genre “installation-simple-boot”, donc si vous modifiez un titre de chapitre ou de sous-chapitre, assurez-vous de modifier tous les liens internes qui s’y rattachent.

Idem pour l’ajout/supression de chapitres qui entrainent une modification de la table des matières... pas grave me direz-vous car elle est auto-générée... sauf que les liens internes des cahiers sont sous la forme “chap 8.3.1” (afin d'être lisible sur la version imprimable). Soyez donc vigilant sur ce genre de modifications.

Pourquoi tu ne parles pas des jeux ?

Le sujet est délicat pour plusieurs raisons:

  • je ne joue pas sur ordinateur. je n’ai donc absolument aucune expérience/légitimité pour développer une documentation à ce sujet.
  • la plupart des gamers souhaitent installer des jeux “propriétaires”, donc pas vraiment l’ambiance Debian GNU/Linux
  • les différents jeux libres/proprios et leurs modes d’installation respectifs sont bien mieux traités sur des forums spécialisés.
  • une section sur les jeux Libres serait intéressante, mais il y a tellement de jeux, de possibilités d’installation, de types de jeux.. ça mériterait “les cahiers du gamer Libre” :D ... une piste peut-être pour un courageux ;)

Le monsieur il est méchant, il a tout viré mes modifs...

Oui, je sais, je suis un pourri... j’ai même viré plus de fichiers à moi qu’aux autres .... je suis auto-pourri :P