DSI-VD/poc_ssi_doc_arch
Watch
2
mirror of https://github.com/DSI-VD/poc_ssi_doc_arch.git synced 2026-08-25 21:14:18 +00:00
Code Releases Activity
Documentation architecture du POC - SSI | Read-only mirror of https://github.com/DSI-VD/poc_ssi_doc_arch — Canton de Vaud. Issues & pull requests at the source.
25 commits 1 branch 0 tags 51 KiB
  • CSS 100%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
rbolog e8907ad119
 remove test file
2022-06-07 10:53:01 +02:00
css move pdf.css to project 2022-03-24 20:49:45 +00:00
src Add text for context diagram level 1 2022-03-28 12:23:38 +02:00
.c4builder move pdf.css to project 2022-03-24 20:49:45 +00:00
.gitignore Update context and readme 2022-03-24 12:02:22 +01:00
.gitpod.Dockerfile update gitpod conf 2022-03-24 16:53:29 +01:00
.gitpod.yml update gitpod conf 2022-03-24 15:04:57 +01:00
LICENSE Add license and gitpod 2022-03-24 14:02:02 +01:00
README.md update readme 2022-03-28 15:42:38 +02:00

README.md

poc_ssi_doc_arch

Introduction

La documentation d'architecture du POC SSI se construit en utilisant une visualisation de type C4 model. L'outil pour générer cette documentation est C4Builder qui utilise (entre autres) PlantUml et C4-PlantUML. Il est aussi possible de créer les diagrammes directement avec PlantUml, il n'y a donc pas de dépendance sur C4Builder.

GitPod

GitPod permet d'avoir un environnement distant sans à avoir à installer les outils. (Notez que la premère invocation est longue, car la machine doit être instanciée)

Open in Gitpod

Prérequis

  • Installer nodejs
  • Installer C4Builder npm i -g c4builder
  • Faire un clone du repo git clone https://github.com/DSI-VD/poc_ssi_doc_arch.git

Optionnel

HowTo

  1. Dans le répertoire ./poc_ssi_doc_arch
  2. Mise à jour git pull

Build

⚠️ WARNING
En l'état ça ne fonctionne pas derrière un proxy
  • Commande: c4builder

Générer un diagramme sans c4builder en utilisant plantuml

Exemple qui génère le diagramme de contexte dans le répertoire $HOME/Téléchargements au format svg

java -jar ~/bin/plantuml-1.2022.2.jar -tsvg ./poc_ssi_doc_arch/src/context.puml -o $HOME/Téléchargements

Documentation et détails

Visualisation

  • Site web local command c4builder site ouvrir
  • PDF ouvrir ./doc/poc_ssi_doc_arch/POC-SSI documentation.pdf
  • Dans l'éditeur VsCode la touche alt+d ou ctlr+shift+P puis la commande Plantuml: Prévisualiser le diagramme