Add a preview note in the guides of preview extensions

This commit is contained in:
Gwenneg Lepage
2019-11-21 23:30:55 +01:00
committed by Guillaume Smet
parent aa6ae88685
commit 4a0fb0ae0e
22 changed files with 146 additions and 12 deletions

View File

@@ -7,7 +7,6 @@ https://github.com/quarkusio/quarkus/tree/master/docs/src/main/asciidoc
include::./attributes.adoc[]
The `quarkus-amazon-lambda-http` extension allows you to write microservices with Resteasy (JAX-RS),
Undertow (servlet), or Vert.x Web and make these microservices deployable as an Amazon Lambda
using https://aws.amazon.com/api-gateway/[Amazon's API Gateway] and https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html[Amazon's SAM framework].
@@ -15,6 +14,13 @@ using https://aws.amazon.com/api-gateway/[Amazon's API Gateway] and https://docs
You can deploy your Lambda as a pure Java jar, or you can compile your project to a native image (GraalVM) and deploy that for a smaller
memory footprint and startup time.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -7,13 +7,19 @@ https://github.com/quarkusio/quarkus/tree/master/docs/src/main/asciidoc
include::./attributes.adoc[]
The `quarkus-amazon-lambda` extension allows you to use Quarkus to build your Amazon Lambda's.
The `quarkus-amazon-lambda` extension allows you to use Quarkus to build your Amazon Lambdas.
Your lambdas can use injection annotations from CDI or Spring and other Quarkus facilities as you need them.
Quarkus lambdas can be deployed using the Amazon Java Runtime, or you can build a native GraalVM executable and use
Amazon's Custom Runtime if you want a smaller memory footprint and faster cold boot startup time.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -8,6 +8,13 @@ include::./attributes.adoc[]
This guide demonstrates how your Quarkus application can utilize MicroProfile Reactive Messaging to interact with AMQP.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -12,6 +12,13 @@ Undertow (servlet), or Vert.x Web and make these microservices deployable to the
One azure function deployment can represent any number of JAX-RS, servlet, or Vert.x Web endpoints.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -17,6 +17,13 @@ NOTE: The DynamoDB extension is based on https://docs.aws.amazon.com/sdk-for-jav
It's a major rewrite of the 1.x code base that offers two programming models (Blocking & Async).
Keep in mind it's actively developed and does not support yet all the features available in SDK 1.x such as https://github.com/aws/aws-sdk-java-v2/issues/36[Document APIs] or https://github.com/aws/aws-sdk-java-v2/issues/35[Object Mappers]
[NOTE]
====
This extension is considered `preview`.
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].
====
The Quarkus extension supports two programming models:
* Blocking access using URL Connection HTTP client (by default) or the Apache HTTP Client

View File

@@ -14,10 +14,10 @@ We will also explore how you can can query your Elasticsearch cluster using the
[WARNING]
====
The version of Hibernate Search shipped with Quarkus is still a Beta.
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.
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].
====
== Prerequisites

View File

@@ -13,6 +13,13 @@ directly in your application.
Check out the link:https://infinispan.org/documentation/[Infinispan
documentation] to find out more about the Infinispan project.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Adding the Infinispan Embedded Extension
After you set up your Quarkus project, run the following command from the base directory:

View File

@@ -8,6 +8,13 @@ include::./attributes.adoc[]
This guide demonstrates how your Quarkus application can use Artemis JMS messaging.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -15,6 +15,13 @@ Drools (for business rules) and jBPM (for business processes). Kogito aims at pr
to business automation where the main message is to expose your business knowledge (processes, rules and decisions)
in a domain specific way.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -11,6 +11,13 @@ https://kotlinlang.org/[Kotlin] is a very popular programming language that targ
Quarkus provides first class support for using Kotlin as will be explained in this guide.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -14,7 +14,12 @@ MongoDB with Panache provides active record style entities (and repositories) li
It is built on top of the link:mongodb[MongoDB Client] extension.
WARNING: This extension is still experimental, feedback is welcome on the https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker].
[NOTE]
====
This extension is considered `preview`.
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].
====
== First: an example

View File

@@ -10,6 +10,13 @@ MongoDB is a well known NoSQL Database that is widely used.
In this guide, we see how you can get your REST services to use the MongoDB database.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -34,9 +34,15 @@ The driver itself is released under the Apache 2.0 license,
while Neo4j itself is available in a GPL3-licensed open-source "community edition",
with online backup and high availability extensions licensed under a closed-source commercial license.
== Programming model
[WARNING]
====
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].
====
NOTE: The Neo4j extension is based on an alpha version of the Neo4j driver. Some interactions with the driver might change in the future.
== Programming model
The driver and thus the Quarkus extension support three different programming models:

View File

@@ -10,6 +10,13 @@ include::./attributes.adoc[]
Modern applications often need to run specific tasks periodically.
In this guide, you learn how to schedule periodic tasks.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:
@@ -19,8 +26,6 @@ To complete this guide, you need:
* JDK 1.8+ installed with `JAVA_HOME` configured appropriately
* Apache Maven 3.5.3+
== Architecture
In this guide, we create a straightforward application accessible using HTTP to get the current value of a counter.

View File

@@ -15,6 +15,13 @@ It can be used to implement an application authentication mechanism based on tok
If your OAuth2 Authentication server provides JWT tokens, you should use link:security-jwt[MicroProfile JWT RBAC] instead, this extension aims to be used with opaque tokens and validate the token by calling an introspection endpoint.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Solution
We recommend that you follow the instructions in the next sections and create the application step by step.

View File

@@ -13,6 +13,13 @@ Bearer Token Authorization is the process of authorizing HTTP requests based on
We are going to give you a guideline on how to use OpenId Connect and OAuth 2.0 in your JAX-RS applications using the Quarkus OpenID Connect Extension.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -24,6 +24,13 @@ There is also a fully worked example in the quickstarts which you may access by
Git repository: `git clone {quickstarts-clone-url}`, or by downloading an {quickstarts-archive-url}[archive].
Look for the `software-transactional-memory-quickstart` example.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Setting it up
To use the extension include it as a dependency in your application pom:

View File

@@ -10,6 +10,13 @@ include::./attributes.adoc[]
While users are encouraged to use Hibernate ORM with Panache for Relational Database access, Quarkus provides a compatibility layer for
Spring Data JPA repositories in the form of the `spring-data-jpa` extension.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -11,6 +11,13 @@ While users are encouraged to use CDI annotations for injection, Quarkus provide
This guide explains how a Quarkus application can leverage the well known Dependency Injection annotations included in the Spring Framework.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -11,6 +11,13 @@ While users are encouraged to use JAX-RS annotation for defining REST endpoints,
This guide explains how a Quarkus application can leverage the well known Spring Web annotations to define RESTful services.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -23,6 +23,13 @@ https://www.vaultproject.io/docs/secrets/kv/index.html[Vault kv secret engine] a
Under the hood, the Quarkus Vault extension takes care of authentication when negotiating a client Vault token plus
any transparent token or lease renewals according to ttl and max-ttl.
[NOTE]
====
This extension is considered `preview`.
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].
====
== Prerequisites
To complete this guide, you need:

View File

@@ -7,4 +7,5 @@ metadata:
- "amazon"
categories:
- "cloud"
guide: "https://quarkus.io/guides/amazon-lambda"
status: "preview"