Add the user guide to the assembly

jakartaee · May 9, 2024 · 82a8b42 · 82a8b42
1 parent b8619b1
commit 82a8b42
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 30 deletions.
diff --git a/tck/tck-dist/src/main/assembly/assembly.xml b/tck/tck-dist/src/main/assembly/assembly.xml
@@ -31,9 +31,25 @@
             <destName>eftl.adoc</destName>
         </file>
     </files>
-        <!-- TODO user guide -->
     <fileSets>
         <fileSet>
+            <directory>${project.basedir}/../tck-docs/userguide/target/generated-docs</directory>
+            <outputDirectory>docs/pdf-usersguide</outputDirectory>
+            <fileMode>755</fileMode>
+            <includes>
+                <include>*.pdf</include>
+            </includes>
+        </fileSet>
+        <fileSet>
+            <directory>${project.basedir}/../tck-docs/userguide/target/staging</directory>
+            <outputDirectory>docs/html-usersguide</outputDirectory>
+            <fileMode>755</fileMode>
+            <includes>
+                <include>*.html</include>
+                <include>css/**</include>
+                <include>img/**</include>
+            </includes>
+        </fileSet>        <fileSet>
             <directory>${project.basedir}/src/main/resources</directory>
             <outputDirectory>artifacts</outputDirectory>
             <fileMode>755</fileMode>

diff --git a/tck/tck-docs/userguide/src/main/jbake/content/toc.adoc b/tck/tck-docs/userguide/src/main/jbake/content/toc.adoc
@@ -32,10 +32,9 @@ link:intro.html#GBFOW[1 Introduction]
 ** 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]
-*** link:intro.html#GBFSA[1.2.3 JavaTest Harness]
-*** link:intro.html#GBFRA[1.2.4 TCK Compatibility Test Suite]
-*** link:intro.html#GBFSH[1.2.5 Exclude Lists]
-*** link:intro.html#GBFRR[1.2.6 TCK Configuration]
+*** link:intro.html#GBFRA[1.2.3 TCK Compatibility Test Suite]
+*** link:intro.html#GBFSH[1.2.4 Exclude Lists]
+*** link:intro.html#GBFRR[1.2.5 TCK Configuration]
 ** link:intro.html#GBFQW[1.3 Getting Started With the TCK]
 
 [[procedure-for-certification]]
@@ -63,43 +62,28 @@ link:install.html#GBFTP[3 Installation]
 link:config.html#GBFVV[4 Setup and Configuration]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-** link:config.html#GHGDH[4.4 Custom Configuration Handlers]
-** link:config.html#GBFWG[4.5 Custom Deployment Handlers]
-*** link:config.html#GBFVA[4.5.1 To Create a Custom Deployment Handler]
-** link:config.html#GBFUY[4.6 Using the JavaTest Harness Software]
-** link:config.html#GBFWG[4.7 Using the JavaTest Harness Configuration GUI]
-*** link:config.html#GBFVA[4.7.1 Configuration GUI Overview]
-*** link:config.html#GBFVD[4.7.2 Starting the Configuration GUI]
-*** link:config.html#GBFVX[4.7.3 To Configure the JavaTest Harness to Run the TCK Tests]
-*** link:config.html#GBFUU[4.7.4 Modifying the Default Test Configuration]
 
 [[executing-tests]]
 link:using.html#GBFWO[5 Executing Tests]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-** link:using.html#GBFUZ[5.1 Starting JavaTest]
-*** link:using.html#GBFWH[5.1.1 To Start JavaTest in GUI Mode]
-*** link:using.html#GBFVW[5.1.2 To Start JavaTest in Command-Line Mode]
+** link:using.html#GBFUZ[5.1 Starting the tests]
+*** link:using.html#GBFVW[5.1.1 To Start Tests in Command-Line Mode]
 ** link:using.html#GBFWM[5.2 Running a Subset of the 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 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]
-*** link:using.html#GBFVB[5.5.2 Viewing an Existing Test Report]
+*** link:using.html#GBFWK[5.2.1 To Run a Subset of Tests in Command-Line Mode]
+*** link:using.html#GBFQA[5.2.2 To Run a Group of Tests in Command-Line Mode]
+** link:using.html#GBFVK[5.3 Running Signature Test]
+** link:using.html#GCLRR[5.4 Running the TCK Against another CI]
+** link:using.html#GCLRZ[5.5 Running the TCK Against a Vendor's Implementation]
+** link:using.html#GBFVK[5.6 Test Reports]
 
 [[debugging-test-problems]]
 link:debug.html#GBFUV[6 Debugging Test Problems]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ** link:debug.html#GBFYP[6.1 Overview]
-** link:debug.html#GBFVF[6.2 Test Tree]
-** link:debug.html#GBFWI[6.3 Folder Information]
-** link:debug.html#GBFVP[6.4 Test Information]
-** link:debug.html#GBFVZ[6.5 Report Files]
-** link:debug.html#GBFYF[6.6 Configuration Failures]
+** link:debug.html#GBFVF[6.2 Test Information]
+** link:debug.html#GBFWI[6.3 Configuration Failures]
 * link:faq.html#GBFYD[A Frequently Asked Questions]
 ** link:faq.html#GBFYQ[A.1 Where do I start to debug a test failure?]
 ** link:faq.html#GBFYR[A.2 How do I restart a crashed test run?]