Merge pull request #865 from kabir/glow-preview-31.0.0.Final

Add glow rendering to README-source of enhanced quickstarts
wildfly · Jan 25, 2024 · 6b40a3b · 6b40a3b
2 parents 636e773 + e7449a9
commit 6b40a3b
Show file tree

Hide file tree

Showing 47 changed files with 50 additions and 1 deletion.
diff --git a/batch-processing/README-source.adoc b/batch-processing/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: CDI, Batch 1.0, JSF
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `batch-processing` quickstart shows how to use chunk oriented batch jobs to import a file to a database.

diff --git a/bmt/README-source.adoc b/bmt/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, BMT
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `bmt` quickstart demonstrates Bean-Managed Transactions (BMT), showing how to manually manage transaction demarcation while accessing JPA entities.

diff --git a/cmt/README-source.adoc b/cmt/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, CMT, JMS
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `cmt` quickstart demonstrates Container-Managed Transactions (CMT), showing how to use transactions managed by the container.

diff --git a/ee-security/README-source.adoc b/ee-security/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EE Security, Servlet, CDI
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ee-security` quickstart demonstrates Jakarta EE security.

diff --git a/ejb-remote/README-source.adoc b/ejb-remote/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, JNDI
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ejb-remote` quickstart uses EJB and JNDI to demonstrate how to access an EJB, deployed to {productName}, from a remote Java client application.

diff --git a/ejb-security-context-propagation/README-source.adoc b/ejb-security-context-propagation/README-source.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Stefan Guilhen
 :level: Advanced
 :technologies: EJB, Security
+:portedToGlow: true
 
 [abstract]
 The `ejb-security-context-propagation` quickstart demonstrates how the security context can be propagated to a remote EJB using a remote outbound connection configuration

diff --git a/ejb-security-programmatic-auth/README-source.adoc b/ejb-security-programmatic-auth/README-source.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Stefan Guilhen
 :level: Intermediate
 :technologies: EJB, Security
+:portedToGlow: true
 
 [abstract]
 The `ejb-security-programmatic-auth` quickstart demonstrates how to programmatically setup different identities when invoking a remote secured EJB.

diff --git a/ejb-throws-exception/README-source.adoc b/ejb-throws-exception/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, EAR
 :deploymentDir: ear
+:portedToGlow: true
 
 [abstract]
 The `ejb-throws-exception` quickstart demonstrates how to throw and handle exceptions across JARs in an EAR.

diff --git a/ejb-timer/README-source.adoc b/ejb-timer/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: EJB Timer
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ejb-timer` quickstart demonstrates how to use the Jakarta Enterprise Bean timer service `@Schedule` and `@Timeout` annotations with {productName}.

diff --git a/ejb-txn-remote-call/README-source.adoc b/ejb-txn-remote-call/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, JTA, Clustering
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ejb-txn-remote-call` quickstart demonstrates remote transactional EJB calls over two application servers of {productName}.

diff --git a/helloworld-jms/README-source.adoc b/helloworld-jms/README-source.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Weston Price
 :level: Intermediate
 :technologies: JMS
+:portedToGlow: true
 
 [abstract]
 The `helloworld-jms` quickstart demonstrates the use of external JMS clients with {productName}.

diff --git a/helloworld-mdb/README-source.adoc b/helloworld-mdb/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: JMS, EJB, MDB
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld-mdb` quickstart uses JMS and EJB Message-Driven Bean (MDB) to create and deploy JMS topic and queue resources in {productName}.

diff --git a/helloworld-singleton/README-source.adoc b/helloworld-singleton/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: EJB, Singleton
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld-singleton` quickstart demonstrates an EJB Singleton Bean that is instantiated once and maintains state for the life of the session.

diff --git a/helloworld-ws/README-source.adoc b/helloworld-ws/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: JAX-WS
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld-ws` quickstart demonstrates a simple Hello World application, bundled and deployed as a WAR, that uses JAX-WS to say Hello.

diff --git a/helloworld/README-source.adoc b/helloworld/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: Servlet
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld` quickstart demonstrates the use of Servlet 6 and is a good starting point to verify {productName} is configured correctly.

diff --git a/hibernate/README-source.adoc b/hibernate/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Hibernate
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `hibernate` quickstart demonstrates how to use Hibernate ORM 6 over Persistence, using Bean Validation, and Enterprise Beans.

diff --git a/http-custom-mechanism/README-source.adoc b/http-custom-mechanism/README-source.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Darran Lofthouse
 :level: Intermediate
 :technologies: EJB, Security
+:portedToGlow: true
 
 [abstract]
 The `http-custom-mechanism` quickstart demonstrates how to implement a custom HTTP authentication mechanism that can be registered with Elytron.

diff --git a/jaxrs-client/README-source.adoc b/jaxrs-client/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: JAX-RS
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `jaxrs-client` quickstart demonstrates Jakarta REST Client API, which interacts with a Jakarta REST Web service that runs on {productName}.

diff --git a/jaxrs-jwt/README-source.adoc b/jaxrs-jwt/README-source.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Martin Mazanek
 :level: Intermediate
 :technologies: JAX-RS, Security
+:portedToGlow: true
 
 [abstract]
 The `jaxrs-jwt` quickstart demonstrates a Jakarta REST secured application using JSON Web Tokens (JWT) with Elytron.

diff --git a/jaxws-ejb/README-source.adoc b/jaxws-ejb/README-source.adoc
@@ -4,6 +4,7 @@ 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.

diff --git a/jaxws-retail/README-source.adoc b/jaxws-retail/README-source.adoc
@@ -4,6 +4,7 @@ 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.

diff --git a/jsonp/README-source.adoc b/jsonp/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: CDI, JSF, JSON-P
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 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.

diff --git a/kitchensink/README-source.adoc b/kitchensink/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: CDI, JSF, JPA, EJB, JAX-RS, BV
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `kitchensink` quickstart demonstrates a localized {javaVersion} web-enabled database application using JSF, CDI, EJB, JPA, and Bean Validation.

diff --git a/logging/README-source.adoc b/logging/README-source.adoc
@@ -4,6 +4,7 @@ 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}.

diff --git a/mail/README-source.adoc b/mail/README-source.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Joel Tosi
 :level: Beginner
 :technologies: JavaMail, CDI, JSF
+:portedToGlow: true
 
 [abstract]
 The `mail` quickstart demonstrates how to send and receive emails using CDI and JSF and with custom Mail provider configured in {productName}.

diff --git a/micrometer/README-source.adoc b/micrometer/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: Micrometer
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `micrometer` quickstart demonstrates the use of the Micrometer library in {productName}.

diff --git a/microprofile-config/README-source.adoc b/microprofile-config/README-source.adoc
@@ -4,6 +4,7 @@ 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}.

diff --git a/microprofile-fault-tolerance/README-source.adoc b/microprofile-fault-tolerance/README-source.adoc
@@ -13,6 +13,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Radoslav Husar, Tomas Hofman
 :level: Intermediate
 :technologies: MicroProfile, Fault Tolerance
+:portedToGlow: true
 
 [abstract]
 The `microprofile-fault-tolerance` quickstart demonstrates how to use Eclipse MicroProfile Fault Tolerance in {productName}.

diff --git a/microprofile-health/README-source.adoc b/microprofile-health/README-source.adoc
@@ -16,6 +16,7 @@ The `microprofile-health` quickstart demonstrates the use of the MicroProfile He
 :archiveType: war
 :archiveName: {artifactId}
 :include-management-port: http://localhost:9990/health/live
+:portedToGlow: true
 
 == What is it?
 

diff --git a/microprofile-jwt/README-source.adoc b/microprofile-jwt/README-source.adoc
@@ -11,6 +11,7 @@ The `microprofile-jwt` quickstart demonstrates the use of the MicroProfile JWT s
 :standalone-server-type: microprofile
 :archiveType: war
 :archiveName: microprofile-jwt.war
+:portedToGlow: true
 
 == What is it?
 

diff --git a/microprofile-lra/README-source.adoc b/microprofile-lra/README-source.adoc
@@ -19,6 +19,7 @@ The `microprofile-lra` quickstart demonstrates the use of the MicroProfile LRA s
 :custom-openshift-layers:
 :extra-openshift-test-arguments:
 :requires-http-route:
+:portedToGlow: true
 
 == What is it?
 

diff --git a/microprofile-openapi/README-source.adoc b/microprofile-openapi/README-source.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Paul Ferraro
 :level: Beginner
 :technologies: MicroProfile OpenAPI
+:portedToGlow: true
 
 [abstract]
 This guide demonstrate how to use the MicroProfile OpenAPI functionality in {productName} to expose an OpenAPI document for a simple REST application.

diff --git a/microprofile-reactive-messaging-kafka/README-source.adoc b/microprofile-reactive-messaging-kafka/README-source.adoc
@@ -14,6 +14,7 @@ The `microprofile-reactive-messaging-kafka` quickstart demonstrates the use of t
 :helm-install-prerequisites: ../microprofile-reactive-messaging-kafka/helm-install-prerequisites.adoc
 :helm-app-name: mp-rm-qs
 :strimzi-version: v1beta2
+:portedToGlow: true
 
 
 == What is it?

diff --git a/microprofile-rest-client/README-source.adoc b/microprofile-rest-client/README-source.adoc
@@ -12,6 +12,7 @@ The `microprofile-rest-client` quickstart demonstrates the use of the MicroProfi
 :archiveType: jar
 :archiveName: {artifactId}
 :rest-client-qs:
+:portedToGlow: true
 
 == What is it?
 

diff --git a/numberguess/README-source.adoc b/numberguess/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: CDI, JSF
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `numberguess` quickstart demonstrates the use of CDI  (Contexts and Dependency Injection) and JSF (JavaServer Faces) in {productName}.

diff --git a/opentelemetry-tracing/README-source.adoc b/opentelemetry-tracing/README-source.adoc
@@ -13,6 +13,7 @@ The `opentelemetry-tracing` quickstart demonstrates the use of the OpenTelemetry
 :archiveType: war
 :archiveName: {artifactId}
 :restoreScriptName: restore-configuration.cli
+:portedToGlow: true
 
 
 == What is it?

diff --git a/remote-helloworld-mdb/README-source.adoc b/remote-helloworld-mdb/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: JMS, EJB, MDB
 :openshift: true
+:portedToGlow: true
 
 :standalone-server-type: full
 :archiveType: war

diff --git a/servlet-async/README-source.adoc b/servlet-async/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Asynchronous Servlet, CDI, EJB
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `servlet-async` quickstart demonstrates how to use asynchronous servlets to detach long-running tasks and free up the request processing thread.

diff --git a/servlet-filterlistener/README-source.adoc b/servlet-filterlistener/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Servlet Filter, Servlet Listener
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `servlet-filterlistener` quickstart demonstrates how to use Servlet filters and listeners in an application.

diff --git a/servlet-security/README-source.adoc b/servlet-security/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Servlet, Security
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `servlet-security` quickstart demonstrates the use of Jakarta EE declarative security to control access to Servlets and Security in {productName}.

diff --git a/shared-doc/attributes.adoc b/shared-doc/attributes.adoc
@@ -191,4 +191,7 @@ endif::[]
 :LinkJBDSInstall:  https://access.redhat.com/documentation/en-us/red_hat_codeready_studio/{JBDSVersion}/html-single/installation_guide/
 :JBDSInstallBookName: Installation Guide
 :LinkJBDSGettingStarted: https://access.redhat.com/documentation/en-us/red_hat_codeready_studio/{JBDSVersion}/html-single/getting_started_with_codeready_studio_tools/
-:JBDSGettingStartedBookName: Getting Started with CodeReady Studio Tools
+:JBDSGettingStartedBookName: Getting Started with CodeReady Studio Tools
+
+// Enable Rendering of Glow configuration in plugin examples
+:portedToGlow: true
diff --git a/spring-resteasy/README-source.adoc b/spring-resteasy/README-source.adoc
@@ -6,6 +6,7 @@ include::../shared-doc/attributes.adoc[]
 :technologies: Resteasy, Spring
 :openshift: true
 :buildRequirements: Java 17 (Java SDK 17) or later and Maven 3.3.1 or later
+:portedToGlow: true
 
 [abstract]
 The `spring-resteasy` quickstart demonstrates how to package and deploy a web application that includes resteasy-spring integration.

diff --git a/temperature-converter/README-source.adoc b/temperature-converter/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: CDI, JSF, SLSB EJB
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `temperature-converter` quickstart does temperature conversion using an EJB Stateless Session Bean (SLSB), CDI, and a JSF front-end client.

diff --git a/thread-racing/README-source.adoc b/thread-racing/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: Batch, CDI, EE Concurrency, JAX-RS, JMS, JPA, JSON, Web Sockets
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 A thread racing web application that demonstrates technologies introduced or updated in the latest Jakarta EE specification.

diff --git a/todo-backend/README-source.adoc b/todo-backend/README-source.adoc
@@ -12,6 +12,7 @@ include::../shared-doc/attributes.adoc[]
 :archiveType: war
 :useHelmChartDir: true
 :helm-install-prerequisites: ../todo-backend/helm-install-prerequisites.adoc
+:portedToGlow: true
 
 [abstract]
 The `todo-backend` quickstart demonstrates how to implement a backend that exposes a HTTP API with JAX-RS

diff --git a/websocket-endpoint/README-source.adoc b/websocket-endpoint/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: CDI, WebSocket, JSON-P
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 Shows how to use WebSockets with JSON to broadcast information to all open WebSocket sessions in {productName}.

diff --git a/websocket-hello/README-source.adoc b/websocket-hello/README-source.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: WebSocket, CDI, JSF
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `websocket-hello` quickstart demonstrates how to create a simple WebSocket application.