search

inspectIT / inspectit-ocelot

inspectIT Ocelot - Java agent for collecting application performance, tracing and behavior data
http://www.inspectit.rocks/
Apache License 2.0
202 stars 69 forks source link

[Feature] - *Create a component diagram for the configserver UI* #1422

Open salim-1997 opened 2 years ago

salim-1997 commented 2 years ago

Is your feature request related to a problem? Please describe. As a first time seeing the code, i had difficulties understanding the relations between the components. I was thinking it would be efficient and more helpful for new contributors in the future to see a diagram explaining the structure of the app.

Describe the solution you'd like We can integrate a UML diagram (or any other type of component diagram) in the config-server UI repo. There are multiple tools available to draw the diagram, one of them is https://app.diagrams.net/ . However if a component is added or deleted , the diagram should be modified.

Describe alternatives you've considered The Optimal solution would be having an automated process ( for example a node module ) to generate this component diagram after each build. That way the diagram is always up to date. Until now there isn't any good solutions to make that happen so the modification should be made manually.

aaronweissler commented 2 years ago

A UML diagram like this should be part of the architecture documentation that is already planned to be realised, see #1324