Skip to content

Commit 2d6e0f4

Browse files
jamezpjamezp
authored
Merge pull request #4185 from jamezp/update-documentation-6.2
[RESTEASY-3066] Migrate documentation from docbook to asciidoc.
2 parents f678b90 + 8328a02 commit 2d6e0f4

File tree

128 files changed

+14305
-18154
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+14305
-18154
lines changed

‎.github/workflows/distribution-build.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# This workflow will build a Java project with Maven
2+
# For more information see: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
3+
4+
name: Build Documentation and Distribution - 6.2
5+
6+
on:
7+
push:
8+
branches:
9+
- 'main'
10+
pull_request:
11+
branches:
12+
- '**'
13+
paths:
14+
- '.github/workflows/distribution-build.yml'
15+
- 'docbook/**'
16+
- 'distribution/**'
17+
18+
# Only run the latest job
19+
concurrency:
20+
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
21+
cancel-in-progress: true
22+
23+
jobs:
24+
25+
build-doc-dist:
26+
runs-on: ubuntu-latest
27+
timeout-minutes: 30
28+
29+
steps:
30+
- uses: actions/checkout@v4
31+
- name: Set up JDK 11
32+
uses: actions/setup-java@v4
33+
with:
34+
java-version: 11
35+
distribution: 'temurin'
36+
cache: 'maven'
37+
- name: Build Documentation and Distribution
38+
run: |
39+
mvn -B -ntp clean install site -DskipTests -Prelease -Pjboss-release

‎.github/workflows/maven.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ on:
1010
paths:
1111
- '.github/workflows/maven.yml'
1212
- '**/pom.xml'
13+
- '!docbook/pom.xml'
14+
- '!distribution/pom.xml'
1315
- 'providers/**'
1416
- 'resteasy-cdi/**'
1517
- 'resteasy-client/**'

‎distribution/assembly.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<outputDirectory>docs/javadocs</outputDirectory>
2020
</fileSet>
2121
<fileSet>
22-
<directory>../docbook/target/docbook/publish/en-US</directory>
22+
<directory>../docbook/target/generated-docs/</directory>
2323
<outputDirectory>docs/userguide</outputDirectory>
2424
</fileSet>
2525
</fileSets>

‎distribution/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<groupId>org.jboss.resteasy</groupId>
66
<artifactId>resteasy-jaxrs-all</artifactId>
77
<version>6.2.9.Final-SNAPSHOT</version>
8+
<relativePath>../pom.xml</relativePath>
89
</parent>
910

1011
<artifactId>resteasy-dist</artifactId>

‎docbook/pom.xml‎

Lines changed: 53 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,17 @@
44

55
<modelVersion>4.0.0</modelVersion>
66
<parent>
7-
<groupId>dev.resteasy.tools</groupId>
8-
<artifactId>resteasy-parent</artifactId>
9-
<version>2.0.4.Final</version>
10-
<relativePath/>
7+
<groupId>org.jboss.resteasy</groupId>
8+
<artifactId>resteasy-jaxrs-all</artifactId>
9+
<version>6.2.9.Final-SNAPSHOT</version>
10+
<relativePath>../pom.xml</relativePath>
1111
</parent>
1212

13-
<groupId>org.jboss.resteasy</groupId>
1413
<artifactId>resteasy-reference-guide</artifactId>
15-
<version>6.2.9.Final-SNAPSHOT</version>
16-
<packaging>jdocbook</packaging>
14+
<packaging>pom</packaging>
1715
<name>RESTEasy Reference Guide</name>
1816
<description/>
1917

20-
<url>https://resteasy.dev</url>
21-
22-
<licenses>
23-
<license>
24-
<name>Apache License 2.0</name>
25-
<url>https://repository.jboss.org/licenses/apache-2.0.txt</url>
26-
<distribution>repo</distribution>
27-
</license>
28-
</licenses>
29-
30-
<scm>
31-
<connection>scm:git:git://github.com/resteasy/resteasy.git</connection>
32-
<developerConnection>scm:git:[email protected]:resteasy/resteasy.git</developerConnection>
33-
<url>https://github.com/resteasy/resteasy/tree/main/</url>
34-
</scm>
35-
36-
<issueManagement>
37-
<system>JIRA</system>
38-
<url>https://issues.redhat.com/browse/RESTEASY</url>
39-
</issueManagement>
40-
41-
<repositories>
42-
<repository>
43-
<id>jboss</id>
44-
<url>https://repository.jboss.org/nexus/content/groups/public/</url>
45-
</repository>
46-
</repositories>
47-
<pluginRepositories>
48-
<pluginRepository>
49-
<id>jboss</id>
50-
<url>https://repository.jboss.org/nexus/content/groups/public/</url>
51-
</pluginRepository>
52-
</pluginRepositories>
53-
5418
<build>
5519
<plugins>
5620
<plugin>
@@ -66,74 +30,60 @@
6630
</configuration>
6731
</plugin>
6832
<plugin>
69-
<groupId>org.jboss.maven.plugins</groupId>
70-
<artifactId>maven-jdocbook-plugin</artifactId>
71-
<version>2.3.10</version>
72-
<extensions>true</extensions>
73-
33+
<groupId>org.asciidoctor</groupId>
34+
<artifactId>asciidoctor-maven-plugin</artifactId>
35+
<version>3.0.0</version>
7436
<dependencies>
7537
<dependency>
76-
<groupId>org.jboss.pressgang</groupId>
77-
<artifactId>pressgang-xslt-ns</artifactId>
78-
<version>3.1.4</version>
79-
</dependency>
80-
<dependency>
81-
<groupId>org.jboss.pressgang</groupId>
82-
<artifactId>pressgang-jdocbook-style</artifactId>
83-
<type>jdocbook-style</type>
84-
<version>3.1.4</version>
38+
<groupId>org.asciidoctor</groupId>
39+
<artifactId>asciidoctorj-pdf</artifactId>
40+
<version>2.3.15</version>
8541
</dependency>
8642
</dependencies>
87-
8843
<configuration>
89-
<sourceDocumentName>master.xml</sourceDocumentName>
90-
<masterTranslation>en-US</masterTranslation>
91-
<sourceDirectory>${project.basedir}/reference/en</sourceDirectory>
92-
<imageResource>
93-
<directory>${project.basedir}/reference/en</directory>
94-
<includes>
95-
<include>images/*</include>
96-
</includes>
97-
</imageResource>
98-
<formats>
99-
<format>
100-
<formatName>html_single</formatName>
101-
<stylesheetResource>classpath:/xslt/org/jboss/pressgang/xhtml-single.xsl</stylesheetResource>
102-
<finalName>index.html</finalName>
103-
<!-- <profilingTypeName>two_pass</profilingTypeName> -->
104-
</format>
105-
<format>
106-
<formatName>html</formatName>
107-
<stylesheetResource>classpath:/xslt/org/jboss/pressgang/xhtml.xsl</stylesheetResource>
108-
<finalName>index.html</finalName>
109-
<!-- <profilingTypeName>two_pass</profilingTypeName> -->
110-
</format>
111-
<format>
112-
<formatName>pdf</formatName>
113-
<stylesheetResource>classpath:/xslt/org/jboss/pressgang/pdf.xsl</stylesheetResource>
114-
<finalName>${project.artifactId}.pdf</finalName>
115-
</format>
116-
<!--<format>-->
117-
<!--<formatName>eclipse</formatName>-->
118-
<!--<stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>-->
119-
<!--<finalName>${project.artifactId}.html</finalName>-->
120-
<!--</format>-->
121-
</formats>
122-
<injections>
123-
<injection>
124-
<name>project.version</name>
125-
<value>${project.version}</value>
126-
</injection>
127-
</injections>
128-
<options>
129-
<xmlTransformerType>saxon</xmlTransformerType>
130-
<xincludeSupported>true</xincludeSupported>
131-
<useRelativeImageUris>true</useRelativeImageUris>
132-
<!-- TODO Probably obsolete after the upgrade to maven-jdocbook-plugin 2.3.0 -->
133-
<docbookVersion>1.72.0</docbookVersion>
134-
<!-- <localeSeparator>-</localeSeparator> -->
135-
</options>
44+
<attributes>
45+
<!-- Attributes to use in the asciidoc source files. Please leave in alphabetical order -->
46+
<channel-stream-version>${channel.stream.version}</channel-stream-version>
47+
<resteasy-version>${project.version}</resteasy-version>
48+
49+
<linkcss>false</linkcss>
50+
</attributes>
51+
<!-- We only want to process the index as it includes the other documents -->
52+
<sourceDocumentName>index.adoc</sourceDocumentName>
53+
<resources>
54+
<resource>
55+
<directory>${project.basedir}/src/main/asciidoc/images</directory>
56+
<targetPath>images</targetPath>
57+
</resource>
58+
</resources>
13659
</configuration>
60+
<executions>
61+
<execution>
62+
<id>output-html</id>
63+
<phase>package</phase>
64+
<goals>
65+
<goal>process-asciidoc</goal>
66+
</goals>
67+
<configuration>
68+
<backend>html5</backend>
69+
</configuration>
70+
</execution>
71+
<execution>
72+
<id>output-pdf</id>
73+
<phase>package</phase>
74+
<goals>
75+
<goal>process-asciidoc</goal>
76+
</goals>
77+
<configuration>
78+
<attributes>
79+
<title>RESTEasy</title>
80+
</attributes>
81+
<backend>pdf</backend>
82+
<!-- Rename the PDF -->
83+
<outputFile>resteasy-reference-guide.pdf</outputFile>
84+
</configuration>
85+
</execution>
86+
</executions>
13787
</plugin>
13888
</plugins>
13989
</build>

0 commit comments

Comments
 (0)