it-swarm.dev

Comment la documentation de Joomla Issue Tracker est-elle générée?

Est-ce que n'importe qui ici peut partager un peu de lumière sur la façon dont ces docs de Joomla ont été faits

http://issues.joomla.org/documentation/

Je sais que les documents sont tirés de fichiers github MD, mais si quelqu'un peut expliquer le processus, je ne trouve pas comment.

4
Dan

La documentation est stockée dans notre repo JIssues GitHub au format Markdown pour faciliter le traitement et la contribution.

Pour afficher les documents sur le site , nous utilisons un script de ligne de commande qui analyse le dossier, analyse le document Markdown en HTML via l'API GitHub, et le rendu est stocké dans la base de données.

7
Michael

Ainsi, le suivi JIssues utilise le framework Joomla - ainsi certaines des dépendances de github sont regroupées via composer de https://github.com/joomla-framework/github-api

Le code spécifique des fichiers md ici https://github.com/joomla/jissues/tree/master/documentation

Le code qui les récupère pour le rendu est ici: https://github.com/joomla/jissues/tree/master/src/App/Support (l'arborescence de fichiers avec le plugin jQuery tree est dans le répertoire contrôleur Filetree.php etc.)

Et enfin, le rendu est dans un modèle twig trouvé ici: https://github.com/joomla/jissues/blob/master/templates/support/documentation.index.twig

5
George Wilson