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

Suggested re-working of Extensions authoring page #279

Closed
nmcl opened this issue Aug 15, 2019 · 1 comment
Closed

Suggested re-working of Extensions authoring page #279

nmcl opened this issue Aug 15, 2019 · 1 comment
Labels
duplicate This issue or pull request already exists

Comments

@nmcl
Copy link
Contributor

nmcl commented Aug 15, 2019

With reference to https://quarkus.io/guides/extension-authors-guide

Lots of good information but perhaps too much information overload for someone wanting to write their first extension. Suggest the following modifications to the guide:

  • is it possible to have a worked example running through the guide to help illustrate some/most/all of the concepts? Even if some basic example doesn't make sense, perhaps use one or more of the existing extensions? A worked example would be preferable though as developers can try it out as they read the guide and make their own modifications to the example to see what works and what breaks. Maybe even using the result as a template for their own first extension.

  • split the guide into smaller linked pages taking the reader/potential author through the most common steps for writing a (basic/simple) extension. There's lot of information in the guide but how much of it is really needed by the first time author?

  • perhaps link out to some extensions used in practice to get the author used to reading extension code in the context of the guide.

  • split the guide into JVM and native sections. Some of the existing text refers to native-only actions on the part of the author so maybe these should be separate and only once someone has written a non-native extension.

@maxandersen
Copy link
Member

duplicate/relates to quarkusio/quarkus#37288

@maxandersen maxandersen added the duplicate This issue or pull request already exists label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

2 participants