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-18769] Add 'Browse the source' links to all the QS READMEs that… #830

Merged
merged 1 commit into from
Dec 20, 2023
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
2 changes: 2 additions & 0 deletions batch-processing/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ The job contains two tasks:

The database schema defines that the column for name is unique. For that reason, any attempt to persist a duplicate value will throw an exception. On the second attempt to run the job, the `ChunkCheckpoint` provides information to skip the contacts that were already persisted.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// Considerations for Use in a Production Environment
include::../shared-doc/development-shortcuts.adoc[leveloffset=+1]
// System Requirements
Expand Down
2 changes: 1 addition & 1 deletion batch-processing/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions bean-validation-custom-constraint/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The `bean-validation-custom-constraint` quickstart demonstrates how to use CDI,

This quickstart does not contain a user interface layer. The purpose of this project is to show you how to test bean validation using custom constraints with Arquillian. In this quickstart, the personAddress field of entity Person is validated using a set of custom constraints defined in the class AddressValidator. If you want to see an example of how to test bean validation with a user interface, look at the link:../kitchensink/README{outfilesuffix}[kitchensink] example.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// Considerations for Use in a Production Environment
include::../shared-doc/development-shortcuts.adoc[leveloffset=+1]
// System Requirements
Expand Down
2 changes: 1 addition & 1 deletion bean-validation-custom-constraint/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions bmt/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ This example shows how to transactionally insert key value pairs into the databa

ifndef::EAPCDRelease[]

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// Considerations for Use in a Production Environment
include::../shared-doc/development-shortcuts.adoc[leveloffset=+1]
// System Requirements
Expand Down
2 changes: 1 addition & 1 deletion bmt/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
3 changes: 3 additions & 0 deletions cmt/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Aspects touched upon in the code:
* XA access to the standard default datasource using the JPA API
* XA access to a JMS queue

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

=== What are Container Managed Transactions?

Prior to EJB, getting the right incantation to ensure sound transactional operation of the business logic was a highly specialized skill. Although this still holds true to a great extent, EJB has provided a series of improvements to allow simplified transaction demarcation notation that is therefore easier to read and test.
Expand Down
2 changes: 1 addition & 1 deletion cmt/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>cmt</artifactId>
Expand Down
3 changes: 3 additions & 0 deletions contacts-jquerymobile/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ This application focuses on *CRUD* in a strictly mobile app using only *jQuery M

Validation is an important part of an application. Typically in an HTML5 app you can let the built-in HTML5 form validation do the work for you. However, mobile browsers do not support this feature at this time. In order to validate the forms, the `jquery.validate` plugin was added, which provides both client-side and server-side validation. Over AJAX, if there is an error, the error is returned and displayed in the form. You can see an example of this in the *Edit* form if you enter an email that is already in use. The application will attempt to insert the error message into a field if that field exists. If the field does not exist then it display it at the top. In addition, there are xref:run_the_qunit_tests[QUnit Tests] for every form of validation.

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

//*************************************************
// Product Release content only
//*************************************************
Expand Down
2 changes: 1 addition & 1 deletion contacts-jquerymobile/functional-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>contacts-jquerymobile-test-webdriver</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion contacts-jquerymobile/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>contacts-jquerymobile</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions ee-security/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ The deployment in this quickstart contains a simple HTTP servlet, which is secur

This quickstart is hard coded to work with a user `quickstartUser` with password `quickstartPwd1!`.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion ee-security/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions ejb-multi-server/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ The root `pom.xml` builds each of the subprojects in an appropriate order.

The server configuration is done using CLI batch scripts located in the root of the quickstart folder.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion ejb-multi-server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>ejb-multi-server</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions ejb-remote/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ The server component is comprised of a stateful EJB and a stateless EJB. It prov
+
The remote client application depends on the remote business interfaces from the server component. This application looks up the stateless and stateful beans via JNDI and invokes a number of methods on them.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion ejb-remote/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>ejb-remote</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions ejb-security-context-propagation/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Finally there is the `RemoteClient` stand-alone client. The client makes calls u
In the real world, remote calls between servers in the servers-to-server scenario would truly be remote and separate.
For the purpose of this quickstart, we make use of a loopback connection to the same server so we do not need two servers just to run the test.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion ejb-security-context-propagation/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>ejb-security-context-propagation</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions ejb-security-programmatic-auth/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ The `ejb-security-programmatic-auth` quickstart demonstrates how to programmatic

The `ejb-security-programmatic-auth` quickstart demonstrates how to invoke a remote secured EJB using the `Elytron` client API to establish different identities. The quickstart client application accomplishes that by looking up and invoking the secured EJB under different `AuthenticationContext`s. Each context is setup to use a different identities and credentials.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion ejb-security-programmatic-auth/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>ejb-security-programmatic-auth</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions ejb-throws-exception/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ The example follows the common "Hello World" pattern, using the following workfl
. The managed bean is annotated as `@RequestScoped`, so the same managed bean instance is used only for the request/response.


// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion ejb-throws-exception/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>ejb-throws-exception</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions ejb-timer/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ The following Jakarta Enterprise Bean Timer services are demonstrated:
* `@Schedule`: Uses this annotation to mark a method to be executed according to the calendar schedule specified in the attributes of the annotation. This example schedules a message to be printed to the server console every 6 seconds.
* `@Timeout`: Uses this annotation to mark a method to execute when a programmatic timer goes off. This example sets the timer to go off every 3 seconds, at which point the method prints a message to the server console.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion ejb-timer/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>ejb-timer</artifactId>
Expand Down
3 changes: 3 additions & 0 deletions ejb-txn-remote-call/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ The propagated transaction enlists two participants
(the database, and a mock XAResource used for quickstart demonstration purposes).
|===

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

== Running the Quickstart

The quickstart elaborates on running the example in <<_running_in_a_bare_metal_environment, a bare metal environment>> and on OpenShift.
Expand Down
2 changes: 1 addition & 1 deletion ejb-txn-remote-call/client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion ejb-txn-remote-call/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion ejb-txn-remote-call/server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions ha-singleton-deployment/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ The example is built and packaged as a single EJB archive.

For more information about singleton deployments, see _HA Singleton Deployments_ in the {LinkDevelopmentGuide}[__{DevelopmentBookName}__] for {DocInfoProductName} located on the Red Hat Customer Portal.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}_1 and {jbossHomeName}_2
Expand Down
2 changes: 1 addition & 1 deletion ha-singleton-deployment/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions ha-singleton-service/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ This example is built and packaged as JAR archive.

For more information about clustered singleton services, see _HA Singleton Service_ in the {LinkDevelopmentGuide}[__{DevelopmentBookName}__] for {DocInfoProductName} located on the Red Hat Customer Portal.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}_1 and {jbossHomeName}_2
Expand Down
2 changes: 1 addition & 1 deletion ha-singleton-service/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions helloworld-jms/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ It contains the following:

. A message consumer that receives message from a JMS destination deployed to a {productName} server.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion helloworld-jms/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>helloworld-jms</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions helloworld-mdb/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ This project creates two JMS resources:
//*************************************************


// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion helloworld-mdb/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions helloworld-mutual-ssl-secured/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Mutual TLS provides the same security as TLS, with the addition of authenticatio

The out of the box configuration for {productName} has one-way TLS enabled by default. This quickstart shows how to configure {productName} with mutual (two-way) TLS authentication in order to secure a WAR application with restricted access.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion helloworld-mutual-ssl-secured/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions helloworld-mutual-ssl/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ The out of the box configuration for {productName} has one-way TLS enabled by de

Before you run this example, you must create the client certificate and configure the server to use two-way TLS.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion helloworld-mutual-ssl/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>
<artifactId>helloworld-mutual-ssl</artifactId>
Expand Down
2 changes: 2 additions & 0 deletions helloworld-singleton/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ The `helloworld-singleton` quickstart demonstrates an EJB Singleton Bean that is

The `helloworld-singleton` quickstart demonstrates the use of an EJB Singleton Bean in {productNameFull}. It is instantiated once and maintains its state for the life of the session.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
2 changes: 1 addition & 1 deletion helloworld-singleton/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Maintain separation between the artifact id and the version to help prevent
merge conflicts between commits changing the GA and those changing the V.
-->
<version>5</version>
<version>6</version>
<relativePath/>
</parent>

Expand Down
2 changes: 2 additions & 0 deletions helloworld-ws/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ The `helloworld-ws` quickstart demonstrates a simple Hello World application, bu

The `helloworld-ws` quickstart demonstrates the use of JAX-WS in {productNameFull} as a simple Hello World application.

// Link to the quickstart source
include::../shared-doc/view-the-source.adoc[leveloffset=+1]
// System Requirements
include::../shared-doc/system-requirements.adoc[leveloffset=+1]
// Use of {jbossHomeName}
Expand Down
Loading
Loading