Add a preview note in the guides of preview extensions #5672
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gwenneg
commented
Nov 21, 2019
Comment on lines
15
to
20
| NOTE: This extension is considered `preview`. | ||
| While APIs are quite stable and the code is of production quality and thoroughly tested, some features are still missing, performance might not be optimal and some APIs or configuration properties might change as the extension matures. | ||
| Feedback is welcome on our https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker]. |
There was a problem hiding this comment.
Maybe the Beta part from the previous version should remain in the guide, I'm not sure about it.
There was a problem hiding this comment.
Yes, it's a bit different because the underlying component is in beta.
gwenneg
commented
Nov 21, 2019
docs/src/main/asciidoc/neo4j.adoc
Outdated
Comment on lines
37
to
42
| NOTE: This extension is considered `preview`. | ||
| It is based on an alpha version of the Neo4j driver. | ||
| Some interactions with the driver, the API or configuration properties might change as the extension matures. | ||
| Feedback is welcome on our https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker]. |
gwenneg
commented
Nov 21, 2019
extensions/amazon-lambda/runtime/src/main/resources/META-INF/quarkus-extension.yaml
Show resolved
Hide resolved
|
cc @gsmet |
gsmet
requested changes
Nov 22, 2019
| ==== | ||
| NOTE: This extension is considered `preview`. | ||
| While APIs are quite stable and the code is of production quality and thoroughly tested, some features are still missing, performance might not be optimal and some APIs or configuration properties might change as the extension matures. | ||
| Feedback is welcome on our https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker]. |
There was a problem hiding this comment.
I really find the version with ==== more readable when you are having a multiline note.
There was a problem hiding this comment.
All notes and warnings are now delimited with ====.
| @@ -12,13 +12,9 @@ You have a Hibernate ORM-based application? You want to provide a full-featured | |||
| With this guide, you'll learn how to synchronize your entities to an Elasticsearch cluster in a heart beat with Hibernate Search. | |||
| We will also explore how you can can query your Elasticsearch cluster using the Hibernate Search API. | |||
|
|
|||
| [WARNING] | |||
There was a problem hiding this comment.
Maybe let's keep it WARNING for the ones with beta components (so the two different ones).
gwenneg
force-pushed
the
issue-5658-preview-extensions
branch
from
f6a75b2
to
57a4c18
Compare
gwenneg
commented
Nov 22, 2019
| While APIs are quite stable and the code is of production quality and thoroughly tested, | ||
| some features are still missing, performance might not be optimal and some APIs might change before the final release. | ||
| This extension is considered `preview`. | ||
| It is based on a beta version of Hibernate Search. |
There was a problem hiding this comment.
I just put this line back, it seemed important.
gsmet
approved these changes
Nov 22, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #5658
The exact same note was added to most preview extensions guides, with a few exceptions that I will highlight in the comments below.