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

Add glow rendering to README-source of enhanced quickstarts #865

Merged
merged 1 commit into from
Jan 25, 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
1 change: 1 addition & 0 deletions batch-processing/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions bmt/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions cmt/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions ee-security/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions ejb-remote/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions ejb-security-context-propagation/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions ejb-security-programmatic-auth/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions ejb-throws-exception/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions ejb-timer/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions ejb-txn-remote-call/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions helloworld-jms/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions helloworld-mdb/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions helloworld-singleton/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions helloworld-ws/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions helloworld/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions hibernate/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions http-custom-mechanism/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions jaxrs-client/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions jaxrs-jwt/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions jaxws-ejb/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions jaxws-retail/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions jsonp/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions kitchensink/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions logging/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions mail/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions micrometer/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions microprofile-config/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions microprofile-fault-tolerance/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions microprofile-health/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
1 change: 1 addition & 0 deletions microprofile-jwt/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
1 change: 1 addition & 0 deletions microprofile-lra/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
1 change: 1 addition & 0 deletions microprofile-openapi/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions microprofile-reactive-messaging-kafka/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
1 change: 1 addition & 0 deletions microprofile-rest-client/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
1 change: 1 addition & 0 deletions numberguess/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions opentelemetry-tracing/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
1 change: 1 addition & 0 deletions remote-helloworld-mdb/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions servlet-async/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions servlet-filterlistener/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions servlet-security/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
5 changes: 4 additions & 1 deletion shared-doc/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions spring-resteasy/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions temperature-converter/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions thread-racing/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions todo-backend/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions websocket-endpoint/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
1 change: 1 addition & 0 deletions websocket-hello/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down