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

Drop Enterprise Architect #326

Open
ascheman opened this issue Aug 12, 2024 · 3 comments
Open

Drop Enterprise Architect #326

ascheman opened this issue Aug 12, 2024 · 3 comments
Labels
documentation hacktoberfest This is a nice ticket for the hacktoberfest help-needed

Comments

@ascheman
Copy link
Member

ascheman commented Aug 12, 2024

As a developer of HSC I would like to get rid of Enterprise Architect (EA)
based diagrams and documentation as I do not have a licence of EA
permanently available, neither do other contributors.

@gernotstarke
Copy link
Member

Idea: replace either with draw.io diagrams (for static diagrams, like building-block view) or PlantUML (for dynamic diagrams, like sequence diagrams).

@ascheman
Copy link
Member Author

ascheman commented Aug 20, 2024

Yes, and we could even use some LLM for the first conversions. ChatGPT created the following PlantUML

hsc-context.puml

from

hsc-context.png

This is at least a start. Any recommendations, @rdmueller?

@startuml
actor User
actor "Build System\n(e.g., Gradle, make)" as BuildSystem

rectangle "Html Sanity Check" as HtmlSanityCheck {
}

rectangle "Local Images" as LocalImages {
}

rectangle "Local HTML file(s)" as LocalHTML {
}

rectangle "External websites & resources" as ExternalResources {
}

User --> HtmlSanityCheck
BuildSystem --> HtmlSanityCheck

HtmlSanityCheck --> LocalImages : checks
HtmlSanityCheck --> LocalHTML : checks
LocalHTML --> LocalImages : references

HtmlSanityCheck --> ExternalResources : checks <<Risk>>
LocalHTML --> ExternalResources : references <<postponed>>

@enduml

@ascheman ascheman removed the ready label Aug 20, 2024
@rdmueller
Copy link
Collaborator

ChatGPT can create both, draw.io and plantUML diagrams. I can give you access to my frontend which is able to display plantUML directly via kroki and correct the code if it is broken. But you need an API key.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation hacktoberfest This is a nice ticket for the hacktoberfest help-needed
Projects
None yet
Development

No branches or pull requests

3 participants