Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
salim-1997 opened this issue May 6, 2022 · 1 comment
Open
Labels
area/config-ui enhancement New feature or request

Comments

@salim-1997
Copy link
Member

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
Copy link
Member

aaronweissler commented May 6, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/config-ui enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants