bflorat / modele-da

Modèle de Dossier d'Architecture
Other
227 stars 105 forks source link

Makefile usage #32

Closed mgrzybek closed 2 years ago

mgrzybek commented 2 years ago
bflorat commented 2 years ago

Merci.

J'ai eu pas mal de dépendances à installer pour faire fonctionner le make pdf (sur ubuntu) :

sudo apt install pandoc librsvg2-bin texlive-latex-base texlive-latex-extra texlive-lang-french

mais j'ai fini par y arriver et le PDF est top. Par contre, ca apporte vraiment quelque chose par rapport à mon script export --pdf ?

bflorat commented 2 years ago

En absence de réponse et comme je ne comprenais pas tout au Makefile ni si c’était ou pas un doublon avec le script d'export déjà existant, j'ai l'ai déplacé (avec le modèle latex) dans un répertoire 'latex'.

Note: j'ai aussi renommé les modèle latex pour enlever la reference à l'urbanisation étant donné que (pour le moment en tout cas), ce n'est pas dans le scope du projet (ce que j'explique dans le README.adoc).

Bien sûr je reste ouvert à toute proposition.

mgrzybek commented 2 years ago

Bonjour,

Le but du Makefile est de refaire une méthode de création de documents qui soit extensible. Par exemple j'ajoute dans un projet que j'ai une cible pour exporter des feuillets draw.io et le logo de ma société directement depuis le site web officiel.

De plus j'utilise un Makefile pour compiler des projets ou lancer des déploiement Terraform.

Au final le modèle de DA est intégré en documentation as code dans les sources du projet.

Une liste de cibles finales que j'ai en général :

Dans le pipeline Gitlab j'exporte les variables d'environnement nécessaires.

bflorat commented 2 years ago

Merci. J'ai peut être loupé quelque chose mais je suis assez moyennement fan de ce makefile:

1) Le gros des fonctionnalités est déjà dans le script export (qui est peut-être perfectible mais fait le taf): export PDF, HTML, adoc 2) L'export odt est à faire mais semble trivial en asciidoctor, je vais regarder [EDIT: c'est fait via un pandoc conteneurisé ] 3) Ce makefile n'est pas containérisé et apporte de lourdes dépendances aux Linux actuels (je suis à peut prêt sûr qu'il ne pourra s’exécuter dans quelques années, une bonne partie des dépendances latex nécessaires ont déjà changé de nom depuis quelques versions Debian).De plus, il ne fonctionne que sur les Debian-flavoured Linux. 4) Je ne suis pas fan de l'approche doc consolidé (un seul PDF/ODT pour tout le DA) car c'est la philosophie même de ce DA de les spliter par rôle. Et de toute façon, il serait trivial d'ajouter cette fonctionnalité dans le script export. 5) L'export vers S3 me semble trop spécifique et aisément externalisable dans des scripts dédiés. 6) Le gros des fonctionnalités sont en doublons avec le script 'export' et je ne veux pas complexifier le projet inutilement. 7) Je dois aussi maintenir la version en anglais du projet, une raison de plus pour éviter les doublons. 8) Presque pas de doc/manuel d'utilisation.

Concernant les cibles de code et IaC, j'ai pas compris le rapport avec le DA.

En l'état, je pense que je vais supprimer ce makefile mais je te propose au poursuivre son développement sur un de tes dépôts Github si tu le désire, pas de problème pour ajouter un lien.

Contributions sur la doc et sur le script 'export' toujours appréciées.

Merci pour l'aide.

mgrzybek commented 1 year ago

Bonjour,

Le but du Makefile est de refaire une méthode de création de documents qui soit extensible. Par exemple j'ajoute dans un projet que j'ai une cible pour exporter des feuillets draw.io et le logo de ma société directement depuis le site web officiel.

De plus j'utilise un Makefile pour compiler des projets ou lancer des déploiementt Terraform.

Au final le modèle de DA est intégré en "documentation as code" dans les sources du projet.

Une liste de cibles finales que j'ai en général :

Dans le pipeline Gitlab j'exporte les variables d'environnement nécessaires.

Obtenir Outlook pour Androidhttps://aka.ms/AAb9ysg


From: Bertrand Florat @.> Sent: Tuesday, May 10, 2022 9:38:11 PM To: bflorat/modele-da @.> Cc: Mathieu Grzybek @.>; Author @.> Subject: Re: [bflorat/modele-da] Makefile usage (PR #32)

En absence de réponse et comme je ne comprenais pas tout au Makefile ni si c’était ou pas un doublon avec le script d'export déjà existant, j'ai l'ai déplacé (avec le modèle latex) dans un répertoire 'latex'.

Note: j'ai aussi renommé les modèle latex pour enlever la reference à l'urbanisation étant donné que (pour le moment en tout cas), ce n'est pas dans le scope du projet (ce que j'explique dans le README.adoc).

Bien sûr je reste ouvert à toute proposition.

— Reply to this email directly, view it on GitHubhttps://github.com/bflorat/modele-da/pull/32#issuecomment-1122788277, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AAJ4DVXSJSLANHMBFWWQAKLVJK3KHANCNFSM5U7GYJ7A. You are receiving this because you authored the thread.Message ID: @.***>