Skip to content

Commit

Permalink
Merge pull request #1241 from lukasj/pers_ug
Browse files Browse the repository at this point in the history 
TCK UG updates - apply the theme to PDF, add Jakarta EE logo to its front page
  • Loading branch information
@scottmarlow
scottmarlow authored Mar 5, 2024
2 parents 304c2f0 + 8a3fe17 commit e271968
Show file tree
Hide file tree
Showing 53 changed files with 167 additions and 3,874 deletions.
6 changes: 4 additions & 2 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ target/
/user_guides/jakartaee/src/main/jbake/content/tck-packages.inc
/user_guides/jakartaee/src/main/jbake/content/title.inc
/user_guides/jakartaee/src/main/jbake/content/attributes.conf
/user_guides/**/toc.adoc
**/src/main/jbake/content/toc.adoc
/nbproject
.idea
*.iml
.project
/glassfish-runner/batch-tck/apitests/test.properties
/glassfish-runner/batch-tck/sigtests/test.properties
.classpath
.settings/
classes/
Expand All @@ -30,4 +31,5 @@ dist/
release/
el/bundle
jakartaeetck-bundles/
/tck-env.cfg
/tck-env.cfg
.DS_Store
246 changes: 31 additions & 215 deletions jpa/docs/userguide/pom.xml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2017, 2022 Oracle and/or its affiliates. All rights reserved.
Copyright (c) 2017, 2024 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
Expand All @@ -16,167 +16,47 @@
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.eclipse.ee4j</groupId>
<artifactId>project</artifactId>
<version>1.0.7</version>
<groupId>jakarta.tck</groupId>
<artifactId>jakarta.tck.user-guide</artifactId>
<version>11.0.0-SNAPSHOT</version>
<relativePath>../../../user_guides/parent/pom.xml</relativePath>
</parent>
<groupId>org.glassfish</groupId>
<artifactId>tck_jpa</artifactId>
<version>3.1.0</version>

<groupId>jakarta.persistence</groupId>
<artifactId>jakarta.persistence-tck-user-guide</artifactId>
<packaging>pom</packaging>
<name>Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Persistence for Jakarta EE, Release 3.1</name>
<version>3.2.0-SNAPSHOT</version>
<name>Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Persistence for Jakarta EE, Release 3.2 ${project.version}</name>

<properties>
<ug.resources.version>${project.parent.version}</ug.resources.version>

<jakarta.spec.name>Persistence</jakarta.spec.name>
<!-- status: DRAFT, BETA, etc., or blank for final -->
<status>DRAFT</status>
</properties>

<distributionManagement>
<site>
<url>scm:git:[email protected]:eclipse-ee4j/jakartaee-tck.git</url>
</site>
</distributionManagement>
<properties>
<asciidoctorj.diagram.version>2.3.0</asciidoctorj.diagram.version>
<asciidoctorj.maven.plugin.version>3.0.0</asciidoctorj.maven.plugin.version>
<asciidoctorj.pdf.version>2.3.13</asciidoctorj.pdf.version>
<asciidoctorj.version>2.5.11</asciidoctorj.version>
<doc.pdf>Jakarta-Persistence-TCK-Users-Guide.pdf</doc.pdf>
<freemarker.version>2.3.32</freemarker.version>
<jbake.maven.plugin.version>2.7.0-rc.7</jbake.maven.plugin.version>
<maven.deploy.skip>true</maven.deploy.skip>
<maven.site.skip>true</maven.site.skip>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<site.output.dir>${project.build.directory}/staging</site.output.dir>
<!-- status: DRAFT, BETA, etc., or blank for final -->
<status></status>
</properties>

<build>
<defaultGoal>package</defaultGoal>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<plugin>
<groupId>org.glassfish.doc</groupId>
<artifactId>glassfish-doc-maven-plugin</artifactId>
<version>1.3</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.0.0</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.3.0</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<plugin>
<groupId>org.jbake</groupId>
<artifactId>jbake-maven-plugin</artifactId>
<version>${jbake.maven.plugin.version}</version>
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>${asciidoctorj.version}</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-diagram</artifactId>
<version>${asciidoctorj.diagram.version}</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>${freemarker.version}</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctorj.maven.plugin.version}</version>
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>${asciidoctorj.pdf.version}</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<version>2.36.0</version>
<configuration>
<pom>
<includes>
<include>pom.xml</include>
</includes>
<sortPom>
<nrOfIndentSpace>4</nrOfIndentSpace>
<!-- default see https://github.com/Ekryd/sortpom/wiki/PredefinedSortOrderProfiles -->
<predefinedSortOrder>recommended_2008_06</predefinedSortOrder>
<!-- Sort properties -->
<sortProperties>true</sortProperties>
<!-- Sort modules -->
<sortModules>true</sortModules>
<!-- Sort plugin executions -->
<sortExecutions>true</sortExecutions>
</sortPom>
</pom>
</configuration>
<executions>
<execution>
<id>check-spotless-poms</id>
<goals>
<goal>check</goal>
</goals>
<phase>validate</phase>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<configuration>
<filesets>
<fileset>
<directory>src/main/jbake/content</directory>
<includes>
<include>toc.adoc</include>
</includes>
</fileset>
</filesets>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<id>enforce-versions</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<requireJavaVersion>
<version>[11,)</version>
<message>You need Java SE 11 or newer</message>
</requireJavaVersion>
</rules>
</configuration>
<id>build-dist</id>
<phase>package</phase>
</execution>
</executions>
</plugin>
Expand All @@ -185,99 +65,35 @@
<artifactId>glassfish-doc-maven-plugin</artifactId>
<executions>
<execution>
<id>generate-book</id>
<goals>
<goal>book</goal>
</goals>
<phase>generate-resources</phase>
<id>generate-toc</id>
<phase>generate-sources</phase>
</execution>
<execution>
<id>generate-toc</id>
<goals>
<goal>toc</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<chapterPatterns>[A-C0-9]+\s.*,Preface.*,Part\s.*</chapterPatterns>
</configuration>
<id>generate-book</id>
<phase>generate-sources</phase>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.jbake</groupId>
<artifactId>jbake-maven-plugin</artifactId>
<configuration>
<outputDirectory>${site.output.dir}</outputDirectory>
<properties>
<status>${status}</status>
</properties>
</configuration>
<executions>
<execution>
<id>build-site</id>
<goals>
<goal>generate</goal>
</goals>
<phase>generate-resources</phase>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<configuration>
<sourceDirectory>${project.build.directory}/book</sourceDirectory>
<sourceDocumentName>book.adoc</sourceDocumentName>
<!-- XXX - below depends on running jbake first -->
<imagesDir>${project.build.directory}/staging/</imagesDir>
<backend>pdf</backend>
<outputFile>${doc.pdf}</outputFile>
<attributes>
<pdf-stylesdir>${project.basedir}/src/theme</pdf-stylesdir>
<pdf-style>jakartaee</pdf-style>
<doctype>book</doctype>
<status>${status}</status>
<compat-mode></compat-mode>
<data-uri></data-uri>
<icons>font</icons>
<pagenums></pagenums>
<toc></toc>
<icons>font</icons>
<sectanchors>true</sectanchors>
<idprefix></idprefix>
<idseparator>-</idseparator>
<docinfo1>true</docinfo1>
<embedAssets>true</embedAssets>
</attributes>
</configuration>
<executions>
<execution>
<id>generate-pdf-doc</id>
<goals>
<goal>process-asciidoc</goal>
</goals>
<phase>generate-resources</phase>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
<executions>
<execution>
<id>deploy-site</id>
<goals>
<goal>publish-scm</goal>
</goals>
<phase>deploy</phase>
<configuration>
<scmBranch>gh-pages</scmBranch>
<skipDeletedFiles>false</skipDeletedFiles>
<checkinComment>Update site</checkinComment>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Loading

0 comments on commit e271968

Please sign in to comment.