La nouvelle génération de documentation
Raspberry Pi présente un nouveau hub de documentation.
Raspberry Pi a lancé la nouvelle génération de sa documentation qui peut être consultée dès aujourd'hui (magpi.cc/documentation). Sur le blog Raspberry Pi (magpi.cc/bringondocs), Alasdair Allan, responsable de la documentation chez Raspberry Pi, déclare : "Le dépôt de documentation lui-même a été laissé à un développement organique. Lorsque je suis arrivé, il devait être restructuré, et une grande partie de la documentation non spécifique à Raspberry Pi devait être éliminée, tandis que d'autres domaines étaient mal desservis et devaient être développés."
Remplacer le format Markdown
La nouvelle version de la documentation " a été conçue par la même équipe qui a créé l'excellente documentation PDF pour Raspberry Pi Pico et RP2040 ".
La documentation PDF pour RP2040 et Raspberry Pi Pico a été réalisée à partir d'une chaîne d'outils basée sur Asciidoc, et "Nous savions dès le début que nous voudrions migrer la documentation actuelle basée sur Markdown vers Asciidoc. Cela nous offrirait des outils plus puissants à l'avenir, et beaucoup plus de flexibilité", explique Alasdair.
Participez
La source Asciidoc du nouveau site de documentation est hébergée sur GitHub (magpi.cc/documentationgit), et le site de documentation est construit et mis à jour automatiquement à l'aide des actions GitHub lorsque quelqu'un pousse sur la branche master.Cependant, nous travaillerons principalement sur la branche " development " du dépôt, qui est la branche par défaut que vous obtiendrez désormais lorsque vous effectuerez un nouveau checkout, et également la branche que vous devriez cibler pour vos demandes de pull ", explique Alasdair (voir magpi.cc/documentationpullrequest). "Nous avons toujours accepté les demandes de retrait de la source basée sur Markdown de notre site de documentation. Au fil des ans, à mesure que l'ensemble de la documentation s'est développé, des centaines de contributeurs de la communauté ont formulé plus de 1 200 demandes de retrait individuelles, allant de la correction de petites fautes de frappe à la création de nouvelles sections entières.
"Avec l'introduction du nouveau site, Raspberry Pi continuera à accepter les demandes de retrait de la nouvelle documentation basée sur Asciidoc.
"Cependant, nous allons être un peu plus ciblés sur ce que nous accepterons dans la documentation, et nous chercherons à garder le référentiel concentré sur les choses spécifiques à Raspberry Pi, plutôt que d'avoir un contenu générique de tutoriel Linux", écrit Alasdair.
„Si vous êtes déjà un contributeur, la chose la plus simple à faire est d'effectuer un nouveau checkout du dépôt."
"J'espère que tous ceux qui ont contribué à la documentation au fil des ans verront le nouveau site comme un grand pas en avant pour rendre notre documentation plus accessible - et, comme toujours, nous acceptons les pull requests. Cependant, si vous êtes déjà un contributeur, la chose la plus simple à faire est d'effectuer un nouveau checkout du dépôt, car les choses ont beaucoup changé."