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.

Sign up for GitHub

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

Document how to set an extension image #30459

Merged
merged 2 commits into from
Jan 30, 2023
Merged

Document how to set an extension image #30459

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3eb6be
Document how to set an extension image.
holly-cummins Jan 18, 2023
cc4249e
Add information about sizes and formats
holly-cummins Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/src/main/asciidoc/extension-metadata.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,15 @@ metadata:
- "reactive"
status: "stable" <6>
guide: "https://quarkus.io/guides/resteasy-reactive" <7>
codestart: <8>
icon-url: "https://quarkus.io/assets/images/about/icon-reactive.svg" <8>
codestart: <9>
name: "resteasy-reactive"
languages:
- "java"
- "kotlin"
- "scala"
artifact: "io.quarkus:quarkus-project-core-extension-codestarts"
config: <9>
config: <10>
- "quarkus.resteasy-reactive."
----

Expand All @@ -50,8 +51,9 @@ metadata:
<5> Categories the extension should appear under on https://code.quarkus.io[code.quarkus.io]. This field can be omitted, the extension will still be listed on https://code.quarkus.io[code.quarkus.io] but won't be categorized
<6> Maturity status that could be `stable`, `preview`, `experimental`. It is up to extension maintainers to evaluate the maturity status and communicate it to the users
<7> Link to the extension guide or documentation page
<8> https://quarkus.io/guides/extension-codestart[Codestart] information
<9> Configuration prefix
<8> Link to an externally hosted image. This is used in the Quarkus dev tools as the extension icon. It should be square, and any resolution greater than 220 pixels. Supported formats are png, jpeg, tiff, webp, and svg. Alternatively, if you https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview[set the social media preview] on the extension's source code repository, the tools will pick up that image.
<9> https://quarkus.io/guides/extension-codestart[Codestart] information
<10> Configuration prefix

And here is the final version of the file included in the runtime JAR augmented with other information collected by the Quarkus Maven plugin:

Expand Down