inspectit-ocelot icon indicating copy to clipboard operation
inspectit-ocelot copied to clipboard

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

Open salim-1997 opened this issue 2 years ago • 1 comments

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.

salim-1997 avatar May 06 '22 09:05 salim-1997

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

aaronweissler avatar May 06 '22 10:05 aaronweissler