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

Add docs note about writing extension with Java and Maven #41008

Merged
merged 1 commit into from
Jun 6, 2024
Merged

Add docs note about writing extension with Java and Maven #41008

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/src/main/asciidoc/building-my-first-extension.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@
:prerequisites-no-graalvm:
include::{includes}/prerequisites.adoc[]

[CAUTION]
====
Writing extension with any other than Java and Maven has **not** been tested by the Quarkus team so your mileage may vary

Check warning on line 34 in docs/src/main/asciidoc/building-my-first-extension.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/building-my-first-extension.adoc", "range": {"start": {"line": 34, "column": 114}}}, "severity": "WARNING"}
if you stray off this path
====

== Basic Concepts

Check warning on line 38 in docs/src/main/asciidoc/building-my-first-extension.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'Basic Concepts'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Basic Concepts'.", "location": {"path": "docs/src/main/asciidoc/building-my-first-extension.adoc", "range": {"start": {"line": 38, "column": 4}}}, "severity": "INFO"}

First things first, we will need to start with some basic concepts.

Check warning on line 40 in docs/src/main/asciidoc/building-my-first-extension.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/building-my-first-extension.adoc", "range": {"start": {"line": 40, "column": 29}}}, "severity": "INFO"}

* JVM mode vs Native mode
** Quarkus is first and foremost a Java framework, that means you can develop, package and run classic JAR applications, that's what we call *JVM mode*.
Expand Down