Skip to content

Commit

Permalink
A few more of Bill's suggested updates
Browse files Browse the repository at this point in the history
Signed-off-by: Ed Bratt <ed.bratt@oracle.com>
  • Loading branch information
edbratt committed Jun 28, 2019
1 parent a91e96a commit 16ddba8
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 26 deletions.
7 changes: 7 additions & 0 deletions user_guides/Template/src/main/jbake/content/config.adoc
Expand Up @@ -11,6 +11,13 @@ Setup and Configuration
[[GBFVV]]


[WARNING]
====
Currently, this is written to describe configuration for only one compatible implementation.
This must be expanded to provide for the possibility of multiple compatible implementations.
====

[[setup-and-configuration]]
4 Setup and Configuration
-------------------------
Expand Down
7 changes: 4 additions & 3 deletions user_guides/Template/src/main/jbake/content/install.adoc
Expand Up @@ -26,9 +26,10 @@ Configuration,"] for instructions on configuring your test environment.
3.1 Obtaining the Compatible Implementation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can obtain the {TechnologyShortName} Compatible Implementation (CI)
({TechnologyRI}) software from the Eclipse EE4J GitHub Organization
(https://github.com/eclipse-ee4j).
Each compatible implementation will provide instructions for obtaining
their product.
Eclipse GlassFish is a compatible implementation which may be obtained
from https://www.eclipse.org/downloads/download.php?file=/glassfish/glassfish-5.1.0.zip

[[GBFTS]][[installing-the-software]]

Expand Down
31 changes: 22 additions & 9 deletions user_guides/Template/src/main/jbake/content/intro.adoc
Expand Up @@ -201,10 +201,11 @@ The {TechnologyShortName} TCK tests run on the following platforms:
^^^^^^^^^^^^^^^^^^^^^^

The JavaTest harness version {JavaTestVersion} is a set of tools
designed to run and manage test suites on different Java and Jakarta EE platforms. The
JavaTest harness can be described as both a Jakarta (or Java) application and a set
designed to run and manage test suites on different Java platforms.
To JavaTest, Jakarta EE can be considered another platform.
The JavaTest harness can be described as both a Java application and a set
of compatibility testing tools. It can run tests on different kinds of
Jakarta (or Java) platforms and it allows the results to be browsed online within
Java platforms and it allows the results to be browsed online within
the JavaTest GUI, or offline in the HTML reports that the JavaTest
harness generates.

Expand Down Expand Up @@ -251,10 +252,11 @@ matches with the filters you are using and queues them up for execution.
^^^^^^^^^^^^^^^^^^^

Each version of a TCK includes an Exclude List contained in a `.jtx`
file. This is a list of test file URLs that identify tests which do not
have to be run for the specific version of the TCK being used. Whenever
tests are run, the JavaTest harness automatically excludes any test on
the Exclude List from being executed.
file.
This is a list of test file URLs that identify tests which do not
have to be run for the specific version of the TCK being used.
Whenever tests are run, the JavaTest harness automatically excludes
any test on the Exclude List from being executed.

A vendor's compatible implementation is not required to pass or run any test on the Exclude List.
The Exclude List file, +{jtxFileName}+, is included in the
Expand All @@ -264,8 +266,10 @@ The Exclude List file, +{jtxFileName}+, is included in the
[NOTE]
=======================================================================
From time to time, updates to the Exclude List are made available on the
Eclipse EE4J Github Organization (https://github.com/eclipse-ee4j) Web site.
From time to time, updates to the Exclude List are made available.
The exclude list is included in the Jakarta EE TCK ZIP archive.
Each time an update is approved and released, the version number
will be incremented.
You should always make sure you are using an up-to-date copy of the
Exclude List before running the {TechnologyShortName} TCK to verify your
implementation.
Expand Down Expand Up @@ -315,6 +319,15 @@ include::intro.inc[]

[[GBFQW]][[getting-started-with-the-tck]]

[WARNING]
====
The following only describes setting up the Eclipse GlassFish
compatible implementation.
This must be rewritten to describe the general setup, followed by
specifics for setting up one or more compatible implementations.
====

1.3 Getting Started With the TCK
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
18 changes: 9 additions & 9 deletions user_guides/Template/src/main/jbake/content/toc.adoc
@@ -1,11 +1,11 @@
type=page
status=published
title=Technology Compatibility Kit User's Guide for Technology Licensees
title=Technology Compatibility Kit User's Guide for Technology Implementors
next=title.html
~~~~~~
include::attributes.conf[]
Technology Compatibility Kit User's Guide for Technology Licensees
==================================================================
Technology Compatibility Kit User's Guide for Technology Implementors
=====================================================================

[[contents]]
Contents
Expand All @@ -17,7 +17,6 @@ link:preface.html#GBFTI[Preface]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

** link:preface.html#GBFUS[Who Should Use This Book]
** link:preface.html#sthref2[Documentation Accessibility]
** link:preface.html#GBFPO[Before You Read This Book]
** link:preface.html#GBFWF[Typographic Conventions]
** link:preface.html#FWBSD[Shell Prompts in Command Examples]
Expand All @@ -29,7 +28,7 @@ link:intro.html#GBFOW[1 Introduction]
*** link:intro.html#GBFQN[1.1.1 Why Compatibility Testing is Important]
*** link:intro.html#GBFPR[1.1.2 TCK Compatibility Rules]
*** link:intro.html#GBFPW[1.1.3 TCK Overview]
*** link:intro.html#GBFPB[1.1.4 Java Community Process (JCP) Program and Compatibility Testing]
*** link:intro.html#GBFPB[1.1.4 Jakarta EE Specification Process (JESP) Program and Compatibility Testing]
** link:intro.html#GBFQR[1.2 About the TCK]
*** link:intro.html#GBFQV[1.2.1 TCK Specifications and Requirements]
*** link:intro.html#GBFSQ[1.2.2 TCK Components]
Expand All @@ -48,15 +47,16 @@ link:rules.html#GBFSN[2 Procedure for Certification]
*** link:rules.html#definitions[2.2.1 Definitions]
*** link:rules.html#sthref7[2.2.2 Rules for {TechnologyFullName} Products]
** link:rules.html#CJAIIBDJ[2.3 Test Appeals Process]
*** link:rules.html#CJAJEAEI[2.3.1 TCK Test Appeals Steps]
*** link:rules.html#sthref8[2.3.2 Test Challenge and Response Forms]
*** link:rules.html#[2.3.1 Valid Challenges]
*** link:rules.html#[2.3.2 Invalid Challenges]
*** link:rules.html#CJAJEAEI[2.3.3 TCK Test Appeals Steps]
** link:rules.html#CJAJECIE[2.4 Specifications for {TechnologyFullName}]
** link:rules.html#CJABAHGI[2.5 Libraries for {TechnologyFullName}]
link:install.html#GBFTP[3 Installation]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
** link:install.html#GBFUD[3.1 Obtaining the Reference Implementation]
** link:install.html#GBFUD[3.1 Obtaining the Compatible Implementation]
** link:install.html#GBFTS[3.2 Installing the Software]
[[setup-and-configuration]]
Expand Down Expand Up @@ -84,7 +84,7 @@ link:using.html#GBFWO[5 Executing Tests]
*** link:using.html#GBFVT[5.2.1 To Run a Subset of Tests in GUI Mode]
*** link:using.html#GBFWK[5.2.2 To Run a Subset of Tests in Command-Line Mode]
*** link:using.html#GBFVL[5.2.3 To Run a Subset of Tests in Batch Mode Based on Prior Result Status]
** link:using.html#GCLRR[5.3 Running the TCK Against the RI]
** link:using.html#GCLRR[5.3 Running the TCK Against another CI]
** link:using.html#GCLRZ[5.4 Running the TCK Against a Vendor's Implementation]
** link:using.html#GBFVK[5.5 Test Reports]
*** link:using.html#GBFWD[5.5.1 Creating Test Reports]
Expand Down
10 changes: 5 additions & 5 deletions user_guides/Template/src/main/jbake/content/using.adoc
Expand Up @@ -175,12 +175,12 @@ Note that multiple `priorStatus` values must be separated by commas.

[[GCLRR]][[running-the-tck-against-the-ri]]

5.3 Running the TCK Against the CI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5.3 Running the TCK Against another CI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This test scenario is ensures that the configuration and deployment of
all the prebuilt {TechnologyShortName} TCK tests against the Compatible
Implementation are successful, and that the TCK is ready for
Some test scenarios are designed to ensure that the configuration and deployment of
all the prebuilt {TechnologyShortName} TCK tests against one Compatible
Implementation are successful operating with other compatible implementations, and that the TCK is ready for
compatibility testing against the Vendor and Compatible Implementations.

1. Verify that you have followed the configuration instructions in
Expand Down

0 comments on commit 16ddba8

Please sign in to comment.