Skip to content

Re-order and condense extension metadata docs - #56490

Open
holly-cummins wants to merge 2 commits into
quarkusio:mainfrom
holly-cummins:reorder-extension-metadata-docs
Open

Re-order and condense extension metadata docs#56490
holly-cummins wants to merge 2 commits into
quarkusio:mainfrom
holly-cummins:reorder-extension-metadata-docs

Conversation

@holly-cummins

@holly-cummins holly-cummins commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

The extension-metadata guide is a bit of a franken-guide, with part of it intended for tooling authors, and part of it intended for extension authors. Normally, this is ok, because the most important bit of the guide for authors was at the top. That changed recently, so this PR:

  • Moved the section about the file users need to edit to first in the document, so it's easy to find
  • Tried to clarify and condense the discussion of file types at the beginning
  • Removed the generated yaml example, which is no longer preferred, and moved its annotations to the generated json example

Deep link to preview: https://quarkus-pr-main-56490-preview.surge.sh/version/main/guides/extension-metadata/

@quarkus-bot

This comment has been minimized.

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown

🎊 PR Preview 67076a3 has been successfully built and deployed to https://quarkus-pr-main-56490-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

@quarkus-bot

This comment has been minimized.

geoand
geoand previously approved these changes Sep 9, 2026
@geoand

geoand commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Ah, this now needs a rebase onto main

@aloubyansky

Copy link
Copy Markdown
Member

I'm sure it was me who messed it up for you. Good luck reviewing my cpe-artifacts compression paragraph.

# Conflicts:
#	docs/src/main/asciidoc/extension-metadata.adoc
@holly-cummins

Copy link
Copy Markdown
Contributor Author

I think it was #55762, so not too bad to merge. A lucky escape. :)

@quarkus-bot

quarkus-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 40ffca3.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

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