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

[WFLY-19676] Fixes OpenShift compatibility column on root README's ToAQ #949

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 12 additions & 12 deletions README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -141,25 +141,25 @@ NOTE: Some of these quickstarts use the H2 database included with {productNameFu
| link:hibernate/README{outfilesuffix}[hibernate]|Hibernate | Yes | The `hibernate` quickstart demonstrates how to use Hibernate ORM 6 over Persistence, using Bean Validation, and Enterprise Beans. | Intermediate | _none_
| link:http-custom-mechanism/README{outfilesuffix}[http-custom-mechanism]|EJB, Security | No | The `http-custom-mechanism` quickstart demonstrates how to implement a custom HTTP authentication mechanism that can be registered with Elytron. | Intermediate | _none_
| link:jaxrs-client/README{outfilesuffix}[jaxrs-client]|JAX-RS | Yes | The `jaxrs-client` quickstart demonstrates Jakarta REST Client API, which interacts with a Jakarta REST Web service that runs on {productName}. | Beginner | _none_
| link:jaxrs-jwt/README{outfilesuffix}[jaxrs-jwt]|JAX-RS, Security | No | The `jaxrs-jwt` quickstart demonstrates a Jakarta REST secured application using JSON Web Tokens (JWT) with Elytron. | Intermediate | _none_
| link:jaxws-ejb/README{outfilesuffix}[jaxws-ejb]|JAX-WS | No | The `jaxws-ejb` quickstart is a working example of the web service endpoint created from an EJB. | Beginner | _none_
| link:jaxws-retail/README{outfilesuffix}[jaxws-retail]|JAX-WS | No | The `jaxws-retail` quickstart is a working example of a simple web service endpoint. | Beginner | _none_
| link:jaxrs-jwt/README{outfilesuffix}[jaxrs-jwt]|JAX-RS, Security | Yes | The `jaxrs-jwt` quickstart demonstrates a Jakarta REST secured application using JSON Web Tokens (JWT) with Elytron. | Intermediate | _none_
| link:jaxws-ejb/README{outfilesuffix}[jaxws-ejb]|JAX-WS | Yes | The `jaxws-ejb` quickstart is a working example of the web service endpoint created from an EJB. | Beginner | _none_
| link:jaxws-retail/README{outfilesuffix}[jaxws-retail]|JAX-WS | Yes | The `jaxws-retail` quickstart is a working example of a simple web service endpoint. | Beginner | _none_
| link:jsonp/README{outfilesuffix}[jsonp]|CDI, JSF, JSON-P | Yes | The `jsonp` quickstart demonstrates how to use the JSON-P API to produce object-based structures and then parse and consume them as stream-based JSON strings. | Beginner | _none_
| link:jta-crash-rec/README{outfilesuffix}[jta-crash-rec]|JTA, Crash Recovery | No | The `jta-crash-rec` quickstart uses JTA and Byteman to show how to code distributed (XA) transactions in order to preserve ACID properties on server crash. | Advanced | _none_
| link:jts/README{outfilesuffix}[jts]|JTS, EJB, JMS | No | The `jts` quickstart shows how to use JTS to perform distributed transactions across multiple containers, fulfilling the properties of an ACID transaction. | Intermediate | link:cmt/README.html[cmt]
| link:kitchensink/README{outfilesuffix}[kitchensink]|CDI, JSF, JPA, EJB, JAX-RS, BV | Yes | The `kitchensink` quickstart demonstrates a localized {javaVersion} web-enabled database application using JSF, CDI, EJB, JPA, and Bean Validation. | Intermediate | _none_
| link:logging/README{outfilesuffix}[logging]|Logging | No | The `logging` quickstart demonstrates how to configure different logging levels in {productName}. | Intermediate | _none_
| link:logging/README{outfilesuffix}[logging]|Logging | Yes | The `logging` quickstart demonstrates how to configure different logging levels in {productName}. | Intermediate | _none_
| link:mail/README{outfilesuffix}[mail]|JavaMail, CDI, JSF | No | The `mail` quickstart demonstrates how to send and receive emails using CDI and JSF and with custom Mail provider configured in {productName}. | Beginner | _none_
| link:messaging-clustering-singleton/README{outfilesuffix}[messaging-clustering-singleton]|JMS, MDB, Clustering | No | The `messaging-clustering-singleton` quickstart uses a JMS topic and a queue to demonstrate clustering using {productName} messaging with MDB singleton configuration where only one node in the cluster will be active. | Advanced | _none_
| link:micrometer/README{outfilesuffix}[micrometer]|Micrometer | Yes | The `micrometer` quickstart demonstrates the use of the Micrometer library in {productName}. | Beginner | _none_
| link:microprofile-config/README{outfilesuffix}[microprofile-config]|MicroProfile Config | No | The `microprofile-config` quickstart demonstrates the use of the MicroProfile Config specification in {productName}. | Beginner | _none_
| link:microprofile-fault-tolerance/README{outfilesuffix}[microprofile-fault-tolerance]|MicroProfile, Fault Tolerance | No | The `microprofile-fault-tolerance` quickstart demonstrates how to use Eclipse MicroProfile Fault Tolerance in {productName}. | Intermediate | _none_
| link:microprofile-health/README{outfilesuffix}[microprofile-health]|MicroProfile Health | No | The `microprofile-health` quickstart demonstrates the use of the MicroProfile Health specification in {productName}. | Beginner | _none_
| link:microprofile-jwt/README{outfilesuffix}[microprofile-jwt]|JWT, Security, MicroProfile | No | The `microprofile-jwt` quickstart demonstrates the use of the MicroProfile JWT specification in {productName}. | Intermediate | _none_
| link:microprofile-lra/README{outfilesuffix}[microprofile-lra]|MicroProfile LRA | No | The `microprofile-lra` quickstart demonstrates the use of the MicroProfile LRA specification in {productName}. | Beginner | _none_
| link:microprofile-openapi/README{outfilesuffix}[microprofile-openapi]|MicroProfile OpenAPI | No | This guide demonstrate how to use the MicroProfile OpenAPI functionality in {productName} to expose an OpenAPI document for a simple REST application. | Beginner | _none_
| link:microprofile-reactive-messaging-kafka/README{outfilesuffix}[microprofile-reactive-messaging-kafka]|MicroProfile Reactive Messaging | No | The `microprofile-reactive-messaging-kafka` quickstart demonstrates the use of the MicroProfile Reactive Messaging specification backed by Apache Kafka in {productName}. | Beginner | _none_
| link:microprofile-rest-client/README{outfilesuffix}[microprofile-rest-client]|MicroProfile REST Client | No | The `microprofile-rest-client` quickstart demonstrates the use of the MicroProfile REST Client specification in {productName}. | Beginner | _none_
| link:microprofile-config/README{outfilesuffix}[microprofile-config]|MicroProfile Config | Yes | The `microprofile-config` quickstart demonstrates the use of the MicroProfile Config specification in {productName}. | Beginner | _none_
| link:microprofile-fault-tolerance/README{outfilesuffix}[microprofile-fault-tolerance]|MicroProfile, Fault Tolerance | Yes | The `microprofile-fault-tolerance` quickstart demonstrates how to use Eclipse MicroProfile Fault Tolerance in {productName}. | Intermediate | _none_
| link:microprofile-health/README{outfilesuffix}[microprofile-health]|MicroProfile Health | Yes | The `microprofile-health` quickstart demonstrates the use of the MicroProfile Health specification in {productName}. | Beginner | _none_
| link:microprofile-jwt/README{outfilesuffix}[microprofile-jwt]|JWT, Security, MicroProfile | Yes | The `microprofile-jwt` quickstart demonstrates the use of the MicroProfile JWT specification in {productName}. | Intermediate | _none_
| link:microprofile-lra/README{outfilesuffix}[microprofile-lra]|MicroProfile LRA | Yes | The `microprofile-lra` quickstart demonstrates the use of the MicroProfile LRA specification in {productName}. | Beginner | _none_
| link:microprofile-openapi/README{outfilesuffix}[microprofile-openapi]|MicroProfile OpenAPI | Yes | This guide demonstrate how to use the MicroProfile OpenAPI functionality in {productName} to expose an OpenAPI document for a simple REST application. | Beginner | _none_
| link:microprofile-reactive-messaging-kafka/README{outfilesuffix}[microprofile-reactive-messaging-kafka]|MicroProfile Reactive Messaging | Yes | The `microprofile-reactive-messaging-kafka` quickstart demonstrates the use of the MicroProfile Reactive Messaging specification backed by Apache Kafka in {productName}. | Beginner | _none_
| link:microprofile-rest-client/README{outfilesuffix}[microprofile-rest-client]|MicroProfile REST Client | Yes | The `microprofile-rest-client` quickstart demonstrates the use of the MicroProfile REST Client specification in {productName}. | Beginner | _none_
| link:numberguess/README{outfilesuffix}[numberguess]|CDI, JSF | Yes | The `numberguess` quickstart demonstrates the use of CDI (Contexts and Dependency Injection) and JSF (JavaServer Faces) in {productName}. | Beginner | _none_
| link:opentelemetry-tracing/README{outfilesuffix}[opentelemetry-tracing]|OpenTelemetry Tracing | Yes | The `opentelemetry-tracing` quickstart demonstrates the use of the OpenTelemetry tracing specification in {productName}. | Beginner | _none_
| link:remote-helloworld-mdb/README{outfilesuffix}[remote-helloworld-mdb]|JMS, EJB, MDB | Yes | The `remote-helloworld-mdb` quickstart demonstrates the use of JMS and EJB Message-Driven Bean in {productName} with a remote broker. | Intermediate | _none_
Expand Down
6 changes: 3 additions & 3 deletions jaxrs-jwt/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ include::../shared-doc/attributes.adoc[]
:author: Martin Mazanek
:level: Intermediate
:technologies: JAX-RS, Security
:standalone-server-type: default
:archiveType: war
:portedToGlow: true
:openshift: true

[abstract]
The `jaxrs-jwt` quickstart demonstrates a Jakarta REST secured application using JSON Web Tokens (JWT) with Elytron.

:standalone-server-type: default
:archiveType: war

== What is it?

This quickstart demonstrates how to secure a Jakarta REST service with JWTs using the Elytron subsystem.
Expand Down
10 changes: 5 additions & 5 deletions jaxws-ejb/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ include::../shared-doc/attributes.adoc[]
:author: R Searls
:level: Beginner
:technologies: JAX-WS
:portedToGlow: true

[abstract]
The `jaxws-ejb` quickstart is a working example of the web service endpoint created from an EJB.

:standalone-server-type: default
:archiveType: war
// Override the archive directory
:archiveDir: {artifactId}/target
// Override the archive name
:archiveName: {artifactId}
:portedToGlow: true
:openshift: true

[abstract]
The `jaxws-ejb` quickstart is a working example of the web service endpoint created from an EJB.

== What is it?

Expand Down
10 changes: 5 additions & 5 deletions jaxws-retail/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ include::../shared-doc/attributes.adoc[]
:author: R Searls
:level: Beginner
:technologies: JAX-WS
:portedToGlow: true

[abstract]
The `jaxws-retail` quickstart is a working example of a simple web service endpoint.

:standalone-server-type: default
:archiveType: war
// Override the archive directory
:archiveDir: {artifactId}/target
// Override the archive name
:archiveName: {artifactId}
:portedToGlow: true
:openshift: true

[abstract]
The `jaxws-retail` quickstart is a working example of a simple web service endpoint.

== What is it?

Expand Down
9 changes: 4 additions & 5 deletions logging/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ include::../shared-doc/attributes.adoc[]
:author: Joel Tosi
:level: Intermediate
:technologies: Logging
:portedToGlow: true

[abstract]
The `logging` quickstart demonstrates how to configure different logging levels in {productName}.

:standalone-server-type: default
:archiveType: war
:restoreScriptName: remove-logging.cli
:portedToGlow: true
:openshift: true

[abstract]
The `logging` quickstart demonstrates how to configure different logging levels in {productName}.

== What is it?

The `logging` quickstart demonstrates how to set up and log different levels of information in {productNameFull}.
Expand Down
10 changes: 5 additions & 5 deletions microprofile-config/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ include::../shared-doc/attributes.adoc[]
:author: Martin Stefanko
:level: Beginner
:technologies: MicroProfile Config
:portedToGlow: true

[abstract]
The `microprofile-config` quickstart demonstrates the use of the MicroProfile Config specification in {productName}.

:standalone-server-type: microprofile
:archiveType: war
:archiveName: {artifactId}
:arq-prerequisities: These tests require that JBOSS_HOME environment variable is set.
:portedToGlow: true
:openshift: true

[abstract]
The `microprofile-config` quickstart demonstrates the use of the MicroProfile Config specification in {productName}.

== What is it?

Expand Down
11 changes: 2 additions & 9 deletions microprofile-fault-tolerance/README-source.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
////
This guide is adapted from the main Quarkus repository
https://github.com/quarkusio/quarkus/tree/master/docs/src/main/asciidoc
////

// Needed to correctly render on GitHub
:productName: WildFly
:standalone-server-type: microprofile

include::../shared-doc/attributes.adoc[]

= microprofile-fault-tolerance: MicroProfile Fault Tolerance
:author: Radoslav Husar, Tomas Hofman
:level: Intermediate
:technologies: MicroProfile, Fault Tolerance
:standalone-server-type: microprofile
:portedToGlow: true
:openshift: true

[abstract]
The `microprofile-fault-tolerance` quickstart demonstrates how to use Eclipse MicroProfile Fault Tolerance in {productName}.
Expand Down
12 changes: 6 additions & 6 deletions microprofile-health/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ include::../shared-doc/attributes.adoc[]
:level: Beginner
:technologies: MicroProfile Health
:management-port-openshift:
:standalone-server-type: microprofile
:archiveType: war
:archiveName: {artifactId}
:include-management-port: http://localhost:9990/health/live
:portedToGlow: true
:openshift: true

// Additional Info for OpenShift
:post-helm-install-actions-openshift: ../microprofile-health/expose-management-port-openshift.adoc
Expand All @@ -19,12 +25,6 @@ include::../shared-doc/attributes.adoc[]
[abstract]
The `microprofile-health` quickstart demonstrates the use of the MicroProfile Health specification in {productName}.

:standalone-server-type: microprofile
:archiveType: war
:archiveName: {artifactId}
:include-management-port: http://localhost:9990/health/live
:portedToGlow: true

== What is it?

MicroProfile Health allows applications to provide information about their state
Expand Down
8 changes: 4 additions & 4 deletions microprofile-jwt/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ include::../shared-doc/attributes.adoc[]
:author: Darran Lofthouse
:level: Intermediate
:technologies: JWT, Security, MicroProfile

[abstract]
The `microprofile-jwt` quickstart demonstrates the use of the MicroProfile JWT specification in {productName}.

:standalone-server-type: microprofile
:archiveType: war
:archiveName: microprofile-jwt.war
:portedToGlow: true
:openshift: true

[abstract]
The `microprofile-jwt` quickstart demonstrates the use of the MicroProfile JWT specification in {productName}.

== What is it?

Expand Down
9 changes: 4 additions & 5 deletions microprofile-lra/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,21 @@ include::../shared-doc/attributes.adoc[]
:author: Martin Stefanko
:level: Beginner
:technologies: MicroProfile LRA

[abstract]
The `microprofile-lra` quickstart demonstrates the use of the MicroProfile LRA specification in {productName}.

:standalone-server-type: microprofile
:configFileName: standalone-microprofile.xml
:archiveType: war
:archiveName: {artifactId}
:microprofile-lra:
:restoreScriptName: restore-configuration.cli
:openshift: true
:custom-bootable-jar-layers:
:custom-openshift-layers:
:extra-openshift-test-arguments:
:requires-http-route:
:portedToGlow: true
:openshift: true

[abstract]
The `microprofile-lra` quickstart demonstrates the use of the MicroProfile LRA specification in {productName}.

== What is it?

Expand Down
8 changes: 4 additions & 4 deletions microprofile-openapi/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ include::../shared-doc/attributes.adoc[]
:author: Paul Ferraro
:level: Beginner
:technologies: MicroProfile OpenAPI
:standalone-server-type: microprofile
:archiveType: war
:archiveName: {artifactId}
:portedToGlow: true
:openshift: true

[abstract]
This guide demonstrate how to use the MicroProfile OpenAPI functionality in {productName} to expose an OpenAPI document for a simple REST application.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]

:standalone-server-type: microprofile
:archiveType: war
:archiveName: {artifactId}

== Prerequisites

To complete this guide, you will need:
Expand Down
7 changes: 3 additions & 4 deletions microprofile-reactive-messaging-kafka/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ include::../shared-doc/attributes.adoc[]
:author: Kabir Khan
:level: Beginner
:technologies: MicroProfile Reactive Messaging

[abstract]
The `microprofile-reactive-messaging-kafka` quickstart demonstrates the use of the MicroProfile Reactive Messaging specification backed by Apache Kafka in {productName}.

:standalone-server-type: microprofile
:archiveType: war
:archiveName: {artifactId}
Expand All @@ -16,7 +12,10 @@ The `microprofile-reactive-messaging-kafka` quickstart demonstrates the use of t
:helm-app-name: mp-rm-qs
:strimzi-version: v1beta2
:portedToGlow: true
:openshift: true

[abstract]
The `microprofile-reactive-messaging-kafka` quickstart demonstrates the use of the MicroProfile Reactive Messaging specification backed by Apache Kafka in {productName}.

== What is it?

Expand Down
8 changes: 4 additions & 4 deletions microprofile-rest-client/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ include::../shared-doc/attributes.adoc[]
:author: Martin Stefanko
:level: Beginner
:technologies: MicroProfile REST Client

[abstract]
The `microprofile-rest-client` quickstart demonstrates the use of the MicroProfile REST Client specification in {productName}.

:standalone-server-type: microprofile
:archiveType: jar
:archiveName: {artifactId}
:rest-client-qs:
:portedToGlow: true
:openshift: true

[abstract]
The `microprofile-rest-client` quickstart demonstrates the use of the MicroProfile REST Client specification in {productName}.

== What is it?

Expand Down