Update the intro doc and introduce some document attributes for thing…

…s that change between releases. Fixes #1768 Signed-off-by: Scott M Stark <[email protected]>
jakartaee · Jan 24, 2025 · ea53b7b · ea53b7b
1 parent 08966f8
commit ea53b7b
Show file tree

Hide file tree

Showing 17 changed files with 347 additions and 353 deletions.
diff --git a/release/src/main/assembly/assembly.xml b/release/src/main/assembly/assembly.xml
@@ -3,7 +3,7 @@
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.2.0 https://maven.apache.org/xsd/assembly-2.2.0.xsd">
     <id>dist</id>
-    <baseDirectory>platform-tck-${project.version}</baseDirectory>
+    <baseDirectory>jakartaeetck</baseDirectory>
     <formats>
         <format>zip</format>
     </formats>

diff --git a/user_guides/platform/src/main/asciidoc/TCKpreface.adoc b/user_guides/platform/src/main/asciidoc/TCKpreface.adoc
@@ -20,16 +20,16 @@ Please see the Title page for additional license information.
 ========================================================================
 
 This book introduces the Test Compatibility Kit (TCK) for the Jakarta
-Platform, Enterprise Edition 11 (Jakarta EE 11) and Jakarta Platform, Enterprise
-Edition 11 Web Profile (Jakarta EE 11 Web Profile), and explains how to
+Platform, Enterprise Edition 11 (Jakarta EE {tck_version}) and Jakarta Platform, Enterprise
+Edition 11 Web Profile (Jakarta EE {tck_version} Web Profile), and explains how to
 configure and run the test suite. It also provides information for
 troubleshooting problems you may encounter as you run the test suite.
 
 The Jakarta Platform, Enterprise Edition 11 Test Compatibility Kit (Jakarta
-EE 11 TCK) is a portable, configurable automated test suite for verifying
-the compatibility of an implementer's compliance with the Jakarta EE 11
+EE {tck_version} TCK) is a portable, configurable automated test suite for verifying
+the compatibility of an implementer's compliance with the Jakarta EE {tck_version}
 Specification (hereafter referred to as the implementer's implementation, or VI).
-The Jakarta EE 11 Platform TCK uses the JavaTest harness version 5.0 to run the
+The Jakarta EE {tck_version} Platform TCK uses the JavaTest harness version 5.0 to run the
 test suite.
 
 
@@ -48,9 +48,9 @@ of this guide.
 Who Should Use This Book
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-This guide is for developers of the Jakarta EE 11 technology to assist them
+This guide is for developers of the Jakarta EE {tck_version} technology to assist them
 in running the test suite that verifies compatibility of their
-implementation of the Jakarta EE 11 Specification.
+implementation of the Jakarta EE {tck_version} Specification.
 
 
 [[GJFXS]][[before-you-read-this-book]]
@@ -62,10 +62,10 @@ Before reading this guide, you should familiarize yourself with the Java
 programming language, the Jakarta Platform, Enterprise Edition 11 (Jakarta EE
 9) Specification, and the JavaTest documentation.
 
-The Jakarta Platform, Enterprise Edition 11 (Jakarta EE 11) Specification can be
+The Jakarta Platform, Enterprise Edition 11 (Jakarta EE {tck_version}) Specification can be
 downloaded from `https://projects.eclipse.org/projects/ee4j.jakartaee-platform`.
 
-For documentation on the test harness used for running the Jakarta EE 11 Platform TCK
+For documentation on the test harness used for running the Jakarta EE {tck_version} Platform TCK
 test suite, see
 `https://wiki.openjdk.java.net/display/CodeTools/Documentation`.
 

diff --git a/user_guides/platform/src/main/asciidoc/book.adoc b/user_guides/platform/src/main/asciidoc/book.adoc
@@ -1,4 +1,8 @@
-= Jakarta EE Platform, Enterprise Edition 11 Test Compatibility Kit User's Guide, Release 11 for Jakarta EE
+
+= Jakarta EE Platform, Enterprise Edition {tck_version} Test Compatibility Kit User's Guide, Release 11 for Jakarta EE
+:tck_version: 11
+:glassfish_version: GlassFish 8.0
+:toc:
 
 include::title.adoc[]
 
@@ -10,7 +14,7 @@ include::rules.adoc[]
 
 include::rules-wp.adoc[]
 
-include::install.adoc[]
+include::install.adoc[tck_version={tck_version},glassfish_version={glassfish_version}]
 
 include::config.adoc[]
 
@@ -30,9 +34,5 @@ include::commonappdeploy.adoc[]
 
 include::database-config.adoc[]
 
-include::ejbql-schema.adoc[]
-
-include::contextrootmappingrules.adoc[]
-
 include::jms-resource-adaptr.adoc[]
 
diff --git a/user_guides/platform/src/main/asciidoc/building.adoc b/user_guides/platform/src/main/asciidoc/building.adoc
@@ -36,7 +36,7 @@ the Solaris platform:
 
 1.  Set the following environment variables in your shell environment to
 use the build infrastructure that comes with the TCK:
-* `TS_HOME` to the directory in which the Jakarta EE 11 Platform TCK software is
+* `TS_HOME` to the directory in which the Jakarta EE {tck_version} Platform TCK software is
 installed.
 * `TS_HOME/bin` to your `PATH` in your command shell.
 * C Shell: +
@@ -71,7 +71,7 @@ build infrastructure
 10.2 Building the Tests
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-To build the Jakarta EE 11 Platform TCK tests using Ant, complete the following
+To build the Jakarta EE {tck_version} Platform TCK tests using Ant, complete the following
 steps:
 
 1.  To build a single test directory, type the following: +
@@ -110,7 +110,7 @@ ant pc
 10.3 Running the Tests
 ~~~~~~~~~~~~~~~~~~~~~~
 
-To run the Jakarta EE 11 Platform TCK tests using Ant, use one of the following
+To run the Jakarta EE {tck_version} Platform TCK tests using Ant, use one of the following
 procedures.
 
 [[GFAOW]][[to-run-a-single-test-directory]]
@@ -215,20 +215,20 @@ HelloHome.class
 10.5 Debugging Service Tests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The Jakarta EE 11 Platform TCK service tests test the compatibility of the Jakarta
+The Jakarta EE {tck_version} Platform TCK service tests test the compatibility of the Jakarta
 Platform, Enterprise Edition Service APIs: Jakarta Mail, JDBC, Jakarta Messaging, Jakarta Transactions,
 Jakarta XML Web Services, Jakarta Web Services Metadata, Jakarta Annotations. The test suite contains sets of
-tests that the JavaTest harness, in conjunction with the Jakarta EE 11 Platform TCK
+tests that the JavaTest harness, in conjunction with the Jakarta EE {tck_version} Platform TCK
 harness extensions, runs from different Jakarta Platform, Enterprise
 Edition containers (Jakarta Enterprise Beans, Jakarta Server Pages, Jakarta Servlet, and application
 client). The test suite wraps each of these tests inside generic
-components, called vehicles. Each Jakarta EE 11 Platform TCK service test has been
+components, called vehicles. Each Jakarta EE {tck_version} Platform TCK service test has been
 set up to run in a default set of vehicles. Each technology's
 specification determines this set. When run as part of the certification
 process, all service API tests must pass in their default vehicle set.
 
 Refer to the `<TS_HOME>/src/vehicle.properties` file to for a list the
-default vehicle sets for the Jakarta EE 11 Platform TCK service API tests.
+default vehicle sets for the Jakarta EE {tck_version} Platform TCK service API tests.
 
 To help you debug service API tests, the test suite provides a mechanism
 that allows for fine-grained control over which tests you can run in
@@ -270,7 +270,7 @@ the Ant `gui` or `runclient` targets:
 Before you run the test or tests, you should temporarily rename the file
 `<TS_HOME>/src/testsuite.jtd`.
 
-Note that you must remove these properties before you run the Jakarta EE 11
+Note that you must remove these properties before you run the Jakarta EE {tck_version}
 TCK test suite for certification.
 
 [[GFARW]][[obtaining-additional-debugging-information]]