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

Add diagram of Quarkus ClassLoader hierarchy #34818

Merged
merged 2 commits into from
Jul 21, 2023

Conversation

holly-cummins
Copy link
Contributor

@holly-cummins holly-cummins commented Jul 18, 2023

I had to draw myself a diagram when reading https://quarkus.io/guides/class-loading-reference. Sharing the diagram, since I think it will help others follow the text.

There’s nothing worse than an image that can’t be edited, so I’ve checked the .key file in as well. I know that not everyone can actually use .key files, so a .key file is semi-worse. :) I looked into redoing the file in Excalidraw or PlantUML, but we would lose control of the fonts. I decided the finished image was more important than maximum inclusiveness on the raw file.

I converted from .key to .svg using https://image.online-convert.com/convert/key-to-svg.

@geoand points out we usually call it "Augmentation ClassLoader," not "Augment ClassLoader." I've confirmed that with a search of our code comments, so updated the guide text with the more usual name.

image

@holly-cummins holly-cummins requested a review from geoand July 18, 2023 13:52
@holly-cummins holly-cummins marked this pull request as draft July 18, 2023 13:52
Copy link
Contributor

@geoand geoand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@holly-cummins holly-cummins marked this pull request as ready for review July 18, 2023 14:10
@github-actions
Copy link

github-actions bot commented Jul 18, 2023

🙈 The PR is closed and the preview is expired.

@holly-cummins
Copy link
Contributor Author

https://quarkus-pr-main-34818-preview.surge.sh/version/main/guides/class-loading-reference is the exact page in the preview that's changed.

Annoyingly, https://quarkus-pr-main-34818-preview.surge.sh/version/main/guides/images/classloader-hierarchy.svg renders fine, but when it's inline in the guide it's blank, at least on the preview. So I think I'll give up on svg and switch to png.

@gsmet gsmet merged commit 29f5d17 into quarkusio:main Jul 21, 2023
@quarkus-bot quarkus-bot bot added this to the 3.3 - main milestone Jul 21, 2023
@geoand geoand changed the title Add diagram of Quarkus hierarchy Add diagram of Quarkus ClassLoader hierarchy Jul 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants