-
Couldn't load subscription status.
- Fork 287
Use puml to generate sources diagrams #482
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
Conversation
|
Big +1 from my side for having a text source for these kind of diagrams, rather than a binary one. |
| rectangle release | ||
| rectangle "remote-resource" | ||
| rectangle scm | ||
| rectangle "scm-ppublish" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo, or is it really named "scm-ppublish" (double 'p')?
| Packaging -[hidden]-> Reporting | ||
| Reporting -[hidden]-> Tools | ||
|
|
||
| clean -[hidden]> compiler |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My PlantUML knowledge is a bit rusty... Is there a difference between -[hidden]-> (as above) and -[hidden]> (here)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also learn by testing ...https://plantuml.com/component-diagram
By default, links between classes have two dashes -- and are vertically oriented. It is possible to use horizontal link by putting a single dash (or dot) like this:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the same page:
It is also possible to change arrow direction by adding
left,right,upordownkeywords inside the arrow:
How would you feel about using that notation? I feel it might be friendlier to those who aren't so familiar with PlantUML and wish to make changes to this diagram.
7379c2e to
ead6233
Compare
FTR, source OpenOffice document has been committed with output png in 9a8edf7 but using PlantUML looks like a very good idea: trying on this schema as a first case is great. I'd love to be able to replace this OpenOffice approach to all the schemas I did, because it is a way to edit, but. not really easy ideally also, generating an image map with links to target urls would be great |
ead6233 to
520132b
Compare
|
I talked to @slawekjaranowski and offered him to support him on the PlanUML issue (even having no experience in creating diagrams, but well sometimes is always the first time). In my fork I started and I think I got the sources diagram okay and also the diagram for the multi subproject guide. But I really struggle to create images like the Maven central picture, as plantUML doesn't offers (by design!) possibilities to "manually" draw lines :( So I'm not sure if it's worth trying to convert non-UML diagramms at all costs. You can see my progress here: https://github.com/Bukama/MavenStuff/blob/main/Maven4/puml/pumlworking.md What do you think @hboutemy @slawekjaranowski ? |
|
@Bukama thanks for works we can finish this PR for source site ... another should be in separate PR |
|
Suppressed by #615 |
We have diagram of Maven sources repositories: https://maven.apache.org/scm.html
https://maven.apache.org/maven-sources.png
I don't see a way to easy edit this png file .... so I try to use a puml for generate it.
The result can look like:
Links in puml also working 😄
If you like it I will continue work.