Skip to content

Commit

Permalink
Copy across user guide from TCK project
Browse files Browse the repository at this point in the history
  • Loading branch information
@markt-asf
markt-asf committed May 9, 2024
1 parent b81ddde commit 3164e61
Show file tree
Hide file tree
Showing 40 changed files with 3,699 additions and 0 deletions.
77 changes: 77 additions & 0 deletions tck/tck-docs/userguide/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# A JBake project template

## About JBake

JBake is a static site generator, it's inspired from jekyll and written
in java. The basic idea is to have templates for the structure of the
page, and the body generated from asciidoc content.

## Pre requisites

- Maven
- JDK8+

Deploying to Github will require password less authentication.

This is done by exporting your SSH public key into your Github account.

## Build the site locally

The site is generated under target/staging.

Open file:///PATH_TO_PROJECT_DIR/target/staging in a browser to view the site.

```
mvn generate-resources
```

Or you can invoke the JBake plugin directly.

```
mvn jbake:build
```

### Rebuild the site on changes

```
mvn jbake:watch
```

If you keep this command running, changes to the sources will be
detected and the site will be rendered incrementally.

This is convenient when writing content.

### Serve the site locally

```
mvn jbake:serve
```

If a webserver is required (e.g. absolute path are used), this command
will start a webserver (jetty) at http://localhost:8820. It will also
watch for changes and rebuild incrementally.

## Deploy the site to Github Pages

```
mvn deploy
```

## Produce a zip file for download

To produce a zip file containing the generated html files, use:

```
mvn package
```

When making a release on GitHub, this zip file should be added to the release.

## Links

- [JBake maven plugin documentation](https://github.com/Blazebit/jbake-maven-plugin)
- [JBake documentation](http://jbake.org/docs/2.5.1)
- [Freemarker documentation](http://freemarker.org/docs)
- [AsciiDoc User Guide](http://asciidoc.org/userguide.html)
- [Asciidoctor quick reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference)
259 changes: 259 additions & 0 deletions tck/tck-docs/userguide/pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2017, 2022 Oracle and/or its affiliates and others.
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
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
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">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.eclipse.ee4j</groupId>
<artifactId>project</artifactId>
<version>1.0.5</version>
</parent>
<groupId>org.glassfish</groupId>
<artifactId>tck_servlet</artifactId>
<packaging>pom</packaging>
<version>6.0.0</version>
<name>Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Servlet for Jakarta EE, Release 6.0</name>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<site.output.dir>${project.build.directory}/staging</site.output.dir>
<maven.site.skip>true</maven.site.skip>
<asciidoctorj.version>2.4.2</asciidoctorj.version>
<asciidoctorj.diagram.version>2.1.0</asciidoctorj.diagram.version>
<asciidoctorj.maven.plugin.version>2.1.0</asciidoctorj.maven.plugin.version>
<asciidoctorj.pdf.version>1.5.3</asciidoctorj.pdf.version>
<jbake.maven.plugin.version>0.3.3</jbake.maven.plugin.version>
<freemarker.version>2.3.30</freemarker.version>
<!-- status: DRAFT, BETA, etc., or blank for final -->
<status></status>
<doc.pdf>Jakarta-Servlet-TCK-Users-Guide.pdf</doc.pdf>
<maven.deploy.skip>true</maven.deploy.skip>
</properties>

<distributionManagement>
<site>
<url>scm:git:git@github.com:eclipse-ee4j/jakartaee-tck.git</url>
</site>
</distributionManagement>

<build>
<defaultGoal>package</defaultGoal>
<plugins>
<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>
<executions>
<execution>
<id>enforce-versions</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<requireJavaVersion>
<version>[1.8.0,)</version>
<message>You need JDK8 or newer</message>
</requireJavaVersion>
</rules>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.glassfish.doc</groupId>
<artifactId>glassfish-doc-maven-plugin</artifactId>
<executions>
<execution>
<id>generate-toc</id>
<phase>generate-resources</phase>
<goals>
<goal>toc</goal>
</goals>
<configuration>
<chapterPatterns>
[0-9]+\s.*,Preface.*,Part\s.*
</chapterPatterns>
</configuration>
</execution>
<execution>
<id>generate-book</id>
<phase>generate-resources</phase>
<goals>
<goal>book</goal>
</goals>
</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>
<phase>generate-resources</phase>
<goals>
<goal>generate</goal>
</goals>
</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 />
<data-uri />
<icons>font</icons>
<pagenums />
<toc />
<icons>font</icons>
<sectanchors>true</sectanchors>
<idprefix />
<idseparator>-</idseparator>
<docinfo1>true</docinfo1>
<embedAssets>true</embedAssets>
</attributes>
</configuration>
<executions>
<execution>
<id>generate-pdf-doc</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
<executions>
<execution>
<id>deploy-site</id>
<phase>deploy</phase>
<goals>
<goal>publish-scm</goal>
</goals>
<configuration>
<scmBranch>gh-pages</scmBranch>
<skipDeletedFiles>false</skipDeletedFiles>
<checkinComment>Update site</checkinComment>
</configuration>
</execution>
</executions>
</plugin>
</plugins>

<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-M3</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>
</build>
</project>
4 changes: 4 additions & 0 deletions tck/tck-docs/userguide/src/main/jbake/assets/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# About

The {{site.title}} project contains the [AsciiDoc](http://asciidoc.org/)
source code for the ...
14 changes: 14 additions & 0 deletions tck/tck-docs/userguide/src/main/jbake/assets/_config.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
remote_theme: jakartaee/jekyll-theme-jakarta-ee

title: [tck_jaxrs_v2_1]
description: [Oracle Technology Compatibility Kit User's Guide for Java API for RESTful Web Services (JAX-RS) 2.1 for Technology Licensees, Release 2.1]

# sidebar links url
links:
source: https://github.com/javaee/tck_jaxrs_v2_1
download: https://github.com/javaee/tck_jaxrs_v2_1/releases
#mailinglist: https://javaee.groups.io/g/tck_jaxrs_v2_1
#javadocs:
docs: https://javaee.github.io/tck_jaxrs_v2_1
#faq:

0 comments on commit 3164e61

Please sign in to comment.