Skip to content

Commit

Permalink
Update rest-data-panache docs to clarify experimental status
Browse files Browse the repository at this point in the history 
The Panache extension for generating CRUD resources is split into 3
packages, the most-used one of which is stable. But readers of the guide
are greeted with a warning claiming the feature is experimental, which
is driving teams away from using it. This patch removes the warning and
clarifies in the compatibility table the status of each package, as per
https://quarkus.io/extensions/?search-regex=panache&status=stable
  • Loading branch information
@AxiomaticFixedChimpanzee
AxiomaticFixedChimpanzee committed Sep 10, 2024
1 parent a486b5d commit 3ac37f8
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/src/main/asciidoc/rest-data-panache.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ include::_attributes.adoc[]
A lot of web applications are monotonous CRUD applications with REST APIs that are tedious to write.

Check warning on line 13 in docs/src/main/asciidoc/rest-data-panache.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'many' or 'much' rather than 'A lot of' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'many' or 'much' rather than 'A lot of' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/rest-data-panache.adoc", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}
To streamline this task, REST Data with Panache extension can generate the basic CRUD endpoints for your entities and repositories.

While this extension is still experimental and provides a limited feature set, we hope to get an early feedback for it.
Currently, this extension supports Hibernate ORM and MongoDB with Panache and can generate CRUD resources that work with `application/json` and `application/hal+json` content.

== Setting up REST Data with Panache

Check warning on line 18 in docs/src/main/asciidoc/rest-data-panache.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'Setting up REST Data with Panache'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Setting up REST Data with Panache'.", "location": {"path": "docs/src/main/asciidoc/rest-data-panache.adoc", "range": {"start": {"line": 18, "column": 4}}}, "severity": "INFO"}
Expand All @@ -23,17 +22,20 @@ Please, check out the next compatibility table to use the right one according to

.Compatibility Table
|===
|Extension |Hibernate | RESTEasy
|Extension |Status |Hibernate |RESTEasy

|<<hr-hibernate-orm,quarkus-hibernate-orm-rest-data-panache>>
|`Stable`
|`ORM`
|`Classic and Reactive`

|<<hr-hibernate-reactive,quarkus-hibernate-reactive-rest-data-panache>>
|`Experimental`
|`Reactive`
|`Reactive`

|<<hr-mongodb,quarkus-mongodb-rest-data-panache>>
|`Experimental`
|`ORM`
|`Classic and Reactive`
|===
Expand Down

0 comments on commit 3ac37f8

Please sign in to comment.