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

Use puml to generate sources diagrams #482

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

slawekjaranowski
Copy link
Member

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:

image

Links in puml also working 😄

If you like it I will continue work.

@slawekjaranowski slawekjaranowski marked this pull request as draft December 31, 2023 10:07
@mthmulders
Copy link
Contributor

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"
Copy link
Contributor

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

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)?

Copy link
Member Author

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:

Copy link
Contributor

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, up or down keywords 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.

@hboutemy
Copy link
Member

I don't see a way to easy edit this png file

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants