search

rogeruiz / scuttle

An automation translation layer for working with Structurizr DSL
https://github.com/rogeruiz/scuttle/issues/9
GNU Affero General Public License v3.0
24 stars 6 forks source link

With tools like Structurizr, this project should leverage that instead #7

Closed rogeruiz closed 2 years ago

rogeruiz commented 2 years ago

Mermaid diagrams are great. And tools like Structurizr by Simon Brown are capable of exporting to various rendering tools. This project has already been used for cloud.gov diagrams, which is great. But I'd like for the Scuttle project to build on the open source projects such as Structurizr and Mermaid/PlantUML with customizable tooling.

I'd like to think of this project as open-source tooling rather than buying into any one single rendering engine. It's been a while since Diagrams as Code was coined, and this project was there in the beginning. But now that DGaC is a bit more mature, I'd like for this to be more accessible. This issue is the tracking of that new thought.

=> Structurizr CLI => PlantUML => https://diagrams.fr.cloud.gov

rogeruiz commented 2 years ago

Thinking about this further today, I have a working prototype using Watchman and PlantUML along with Structurizr to automatically generate PNGs on save of .dsl files. There's a bit of a documentation gap right now though. But I now have a working example and will probably just borrow the ones from the documentation as examples for this repository to show things off.

I believe the only thing I'm missing at this point is a local web server and a deployable build step to manage static sites of the output of these PNGs.

All that sounds very ambitious and might not be done for a while though.

rogeruiz commented 2 years ago

This is closed with the recent repository changes. 🎉