0

For a project I'm working on I'd like to adopt the C4 diagramming language to illustrate technical designs. In order to manage changes to the designs I'd like to use PlantUML so that I can express the diagrams as text which can be tracked in a Git repo (Azure DevOps).

The diagrams will appear in a Confluence wiki, but I don't want to manually render and upload the diagrams to Confluence because they will quickly become out of date. My research suggests that the best way around this is to use a PlantUML proxy server which you make a call to, providing the link to the PlantUML (.puml) file in Git as a parameter.

enter image description here

It's easy enough to spin up the PlantUML server in Azure as a docker container, but it seems pretty complicated to manage the authentication between it, Confluence, and the git repo. I've seen that there is also a Confluence plugin available but I wanted to check with the community whether this is the easiest solution or whether there's anything else that I haven't considered?

TheRealJimShady
  • 3,815
  • 4
  • 21
  • 40
  • The easiest is to render things via PlantUML.com, but obviously it's not private. See https://stackoverflow.com/a/32771815/1168342 – Fuhrmanator Dec 29 '22 at 21:21
  • Git itself won't be aware of any of this. You'll use Git in the usual way, whatever that may be. – torek Dec 30 '22 at 01:47
  • Thanks @Fuhrmanator, in that example they're using Github which provides a handy link to the raw files that can be used in the request to the PlantUML proxy. In Azure devops its not as simple, so it's discussion on that here; https://stackoverflow.com/questions/54137998/is-it-possible-to-have-a-link-to-raw-content-of-file-in-azure-devops – TheRealJimShady Dec 30 '22 at 22:23
  • Yes I know @torek, that wasn't the question. – TheRealJimShady Dec 30 '22 at 22:25
  • 1
    I was just telling you why the tag [tag:git] is inappropriate here. – torek Dec 31 '22 at 01:50
  • It's not inappropriate because there would need to be some authentication with Git in order to retrieve the files. – TheRealJimShady Jan 01 '23 at 08:11

0 Answers0