First pass of Jetty 10 doc re-work
Signed-off-by: Chris Walker <chris@webtide.com>
This commit is contained in:
Chris Walker
parent
30513f9afc
commit
053838eee9
|
|
@ -10,14 +10,93 @@
|
|||
<name>Jetty :: Documentation</name>
|
||||
<packaging>pom</packaging>
|
||||
<properties>
|
||||
<maven.build.timestamp.format>yyyy-MM-dd HH:mm</maven.build.timestamp.format>
|
||||
<html.common.directory>${project.build.directory}/html/common</html.common.directory>
|
||||
<html.image.directory>${project.build.directory}/html/common/images</html.image.directory>
|
||||
<javadoc.version>${project.version}</javadoc.version>
|
||||
<asciidoctor.maven.plugin.version>1.5.7.1</asciidoctor.maven.plugin.version>
|
||||
<asciidoctorj.pdf.version>1.5.0-alpha.16</asciidoctorj.pdf.version>
|
||||
<asciidoctorj.epub.version>1.5.0-alpha.8.1</asciidoctorj.epub.version>
|
||||
<asciidoctorj.version>1.5.8.1</asciidoctorj.version>
|
||||
<jruby.version>1.7.27</jruby.version>
|
||||
<web.resources.version>1.0-SNAPSHOT</web.resources.version>
|
||||
<web.resources.directory>${project.build.directory}/web-resources</web.resources.directory>
|
||||
<!-- old properties -->
|
||||
<html.directory>${project.build.directory}/current</html.directory>
|
||||
<javadoc.version>${project.version}</javadoc.version>
|
||||
</properties>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-dependency-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>unpack-jetty-web-resouces</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>unpack</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<artifactItems>
|
||||
<artifactItem>
|
||||
<groupId>org.eclipse.jetty.toolchain</groupId>
|
||||
<artifactId>jetty-web-resources</artifactId>
|
||||
<version>${web.resources.version}</version>
|
||||
<type>jar</type>
|
||||
<overWrite>true</overWrite>
|
||||
<outputDirectory>${web.resources.directory}</outputDirectory>
|
||||
</artifactItem>
|
||||
</artifactItems>
|
||||
<excludes>META-INF/**</excludes>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>copy-base-html-assets</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>copy-resources</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<resources>
|
||||
<resource>
|
||||
<directory>${web.resources.directory}/html</directory>
|
||||
<includes>
|
||||
<include>**</include>
|
||||
</includes>
|
||||
</resource>
|
||||
</resources>
|
||||
<outputDirectory>${html.common.directory}</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
|
||||
<!-- TODO resolve image locations -->
|
||||
<execution>
|
||||
<id>copy-topic-image-assets</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>copy-resources</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<resources>
|
||||
<resource>
|
||||
<directory>src/main/asciidoc/topics</directory>
|
||||
<includes>
|
||||
<include>**/*.jpg</include>
|
||||
<include>**/*.png</include>
|
||||
</includes>
|
||||
</resource>
|
||||
</resources>
|
||||
<outputDirectory>${html.image.directory}</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
<!-- ^^^^^ -->
|
||||
<!-- legacy resources -->
|
||||
<execution>
|
||||
<id>copy-assets</id>
|
||||
<phase>process-resources</phase>
|
||||
|
|
@ -36,203 +115,188 @@
|
|||
<outputDirectory>${html.directory}</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
<!-- ^^legacy resources^^ -->
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
<version>${asciidoctor.maven.plugin.version}</version>
|
||||
<configuration>
|
||||
<basedir>${basedir}/src/main/asciidoc</basedir>
|
||||
<attributes>
|
||||
<JDURL>http://www.eclipse.org/jetty/javadoc/${javadoc.version}</JDURL>
|
||||
<JXURL>http://download.eclipse.org/jetty/stable-9/xref</JXURL>
|
||||
<SRCDIR>${basedir}/..</SRCDIR>
|
||||
<GITBROWSEURL>https://github.com/eclipse/jetty.project/tree/master</GITBROWSEURL>
|
||||
<GITDOCURL>https://github.com/eclipse/jetty.project/tree/jetty-10.0.x-doc-refactor/jetty-documentation/src/main/asciidoc</GITDOCURL>
|
||||
<GUIDEBASEURL>https://eclipse.org/jetty/documentation</GUIDEBASEURL>
|
||||
<MVNCENTRAL>http://central.maven.org/maven2</MVNCENTRAL>
|
||||
<VERSION>${project.version}</VERSION>
|
||||
<TIMESTAMP>${maven.build.timestamp}</TIMESTAMP>
|
||||
<DOCINFODIR>${web.resources}</DOCINFODIR>
|
||||
</attributes>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>output-html</id>
|
||||
<phase>compile</phase>
|
||||
<id>quickstart-guide</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>docbook</backend>
|
||||
<doctype>book</doctype>
|
||||
<backend>html5</backend>
|
||||
<!--<templateDir>${web.resources.directory}/asciidoc/template</templateDir>-->
|
||||
<sourceDirectory>${basedir}/src/main/asciidoc/quick-start</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<attributes>
|
||||
<sub-order>attributes+</sub-order>
|
||||
<imagesdir />
|
||||
<linkcss>true</linkcss>
|
||||
<allow-uri-read>true</allow-uri-read>
|
||||
<toc>true</toc>
|
||||
<revnumber>${project.version}</revnumber>
|
||||
<JDURL>http://www.eclipse.org/jetty/javadoc/${javadoc.version}</JDURL>
|
||||
<JXURL>http://download.eclipse.org/jetty/stable-9/xref</JXURL>
|
||||
<SRCDIR>${basedir}/..</SRCDIR>
|
||||
<GITBROWSEURL>https://github.com/eclipse/jetty.project/tree/jetty-10.0.x</GITBROWSEURL>
|
||||
<MVNCENTRAL>https://repo1.maven.org/maven2</MVNCENTRAL>
|
||||
<VERSION>${project.version}</VERSION>
|
||||
</attributes>
|
||||
<outputDirectory>${project.build.directory}/html/quickstart-guide</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>com.agilejava.docbkx</groupId>
|
||||
<artifactId>docbkx-maven-plugin</artifactId>
|
||||
<version>2.0.17</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>html</id>
|
||||
<phase>compile</phase>
|
||||
<id>admin-guide</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<htmlStylesheet>css/docbook.css</htmlStylesheet>
|
||||
<htmlCustomization>${project.basedir}/src/main/docbkx-stylesheet/html/docbook.xsl</htmlCustomization>
|
||||
<preProcess>
|
||||
<!-- pull over the images from the source material -->
|
||||
<copy todir="target/docbkx/html/images" flatten="true">
|
||||
<fileset dir="src/main/asciidoc">
|
||||
<include name="**/*.png" />
|
||||
<include name="**/*.jpg" />
|
||||
<include name="**/*.svg" />
|
||||
<include name="**/*.dot" />
|
||||
</fileset>
|
||||
</copy>
|
||||
<copy todir="target/docbkx/html/images">
|
||||
<fileset dir="src/main/docbkx-resources/images" />
|
||||
</copy>
|
||||
<copy todir="target/docbkx/html/css">
|
||||
<fileset dir="src/main/docbkx-resources/css" />
|
||||
</copy>
|
||||
<copy todir="target/docbkx/html/fonts">
|
||||
<fileset dir="src/main/docbkx-resources/fonts" />
|
||||
</copy>
|
||||
<copy todir="target/docbkx/html/js">
|
||||
<fileset dir="src/main/docbkx-resources/js" />
|
||||
</copy>
|
||||
</preProcess>
|
||||
<backend>html5</backend>
|
||||
<!--<<templateDir>${web.resources.directory}/asciidoc/template</templateDir>-->
|
||||
<sourceDirectory>${basedir}/src/main/asciidoc/administration-guide</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<outputDirectory>${project.build.directory}/html/administration-guide</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<!-- shared configuration -->
|
||||
<sourceDirectory>${project.build.directory}/generated-docs</sourceDirectory>
|
||||
<includes>index.xml</includes>
|
||||
<generatedSourceDirectory>${project.build.directory}/docbkx/generated</generatedSourceDirectory>
|
||||
<chunkedOutput>true</chunkedOutput>
|
||||
<highlightSource>true</highlightSource>
|
||||
</configuration>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.sf.docbook</groupId>
|
||||
<artifactId>docbook-xml</artifactId>
|
||||
<version>5.1b4-all</version>
|
||||
<classifier>resources</classifier>
|
||||
<type>zip</type>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.sf.xslthl</groupId>
|
||||
<artifactId>xslthl</artifactId>
|
||||
<version>2.0.1</version>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.eclipse.jetty.toolchain</groupId>
|
||||
<artifactId>jetty-xslt-tools</artifactId>
|
||||
<version>1.3</version>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-assembly-plugin</artifactId>
|
||||
<configuration>
|
||||
<descriptors>
|
||||
<descriptor>src/main/assembly/html.xml</descriptor>
|
||||
</descriptors>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>make-assembly</id>
|
||||
<phase>package</phase>
|
||||
<id>contribution-guide</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>single</goal>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>html5</backend>
|
||||
<!--<<templateDir>${web.resources.directory}/asciidoc/template</templateDir>-->
|
||||
<sourceDirectory>${basedir}/src/main/asciidoc/contribution-guide</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<outputDirectory>${project.build.directory}/html/contribution-guide</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>developer-guide</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>html5</backend>
|
||||
<sourceDirectory>${basedir}/src/main/asciidoc/developer-guide</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<outputDirectory>${project.build.directory}/html/developer-guide</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
<!--
|
||||
Couple of different approaches to generating pdf's
|
||||
-->
|
||||
<profile>
|
||||
<id>generate-pdf</id>
|
||||
<id>alt-formats</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>com.agilejava.docbkx</groupId>
|
||||
<artifactId>docbkx-maven-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-pdf</id>
|
||||
<phase>compile</phase>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<includes>index.xml</includes>
|
||||
<fop1Extensions>1</fop1Extensions>
|
||||
<paperType>A4</paperType>
|
||||
<foCustomization>src/main/docbkx-stylesheet/fo/docbook.xsl</foCustomization>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.sf.offo</groupId>
|
||||
<artifactId>fop-hyph</artifactId>
|
||||
<version>1.2</version>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
<version>${asciidoctor.maven.plugin.version}</version>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctorj-pdf</artifactId>
|
||||
<version>1.5.0-alpha.11</version>
|
||||
<version>${asciidoctorj.pdf.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctorj-epub3</artifactId>
|
||||
<version>${asciidoctorj.epub.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.jruby</groupId>
|
||||
<artifactId>jruby-complete</artifactId>
|
||||
<version>${jruby.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctorj</artifactId>
|
||||
<version>${asciidoctorj.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<configuration>
|
||||
<imagesdir/>
|
||||
<backend>docbook</backend>
|
||||
<basedir>${basedir}/src/main/asciidoc</basedir>
|
||||
<attributes>
|
||||
<revnumber>${project.version}</revnumber>
|
||||
<JDURL>http://www.eclipse.org/jetty/javadoc/${javadoc.version}</JDURL>
|
||||
<JXURL>http://download.eclipse.org/jetty/stable-9/xref</JXURL>
|
||||
<SRCDIR>${basedir}/..</SRCDIR>
|
||||
<GITBROWSEURL>https://github.com/eclipse/jetty.project/tree/master</GITBROWSEURL>
|
||||
<MVNCENTRAL>http://central.maven.org/maven2</MVNCENTRAL>
|
||||
<VERSION>${project.version}</VERSION>
|
||||
</attributes>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>output-pdf</id>
|
||||
<phase>generate-sources</phase>
|
||||
<id>contribution-guide-pdf</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>pdf</backend>
|
||||
<sourceHighlighter>rouge</sourceHighlighter>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<sourceHighlighter>coderay</sourceHighlighter>
|
||||
<attributes>
|
||||
<imagesdir />
|
||||
<version>${project.version}</version>
|
||||
<linkcss>true</linkcss>
|
||||
<allow-uri-read>true</allow-uri-read>
|
||||
<toc>true</toc>
|
||||
<revnumber>${project.version}</revnumber>
|
||||
<JDURL>http://download.eclipse.org/jetty/stable-9/apidocs</JDURL>
|
||||
<JXURL>http://download.eclipse.org/jetty/stable-9/xref</JXURL>
|
||||
<SRCDIR>${basedir}/../jetty.project/</SRCDIR>
|
||||
<GITBROWSEURL>https://github.com/eclipse/jetty.project/jetty-10.0.x</GITBROWSEURL>
|
||||
<icons>font</icons>
|
||||
<pagenums/>
|
||||
<toc/>
|
||||
<idprefix/>
|
||||
<idseparator>-</idseparator>
|
||||
</attributes>
|
||||
<sourceDirectory>${basedir}/src/main/asciidoc/contribution-guide</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<outputFile>${project.build.directory}/pdf/contribution-guide/contribution-guide.pdf</outputFile>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>quickstart-distribution-guide-pdf</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>pdf</backend>
|
||||
<sourceHighlighter>coderay</sourceHighlighter>
|
||||
<attributes>
|
||||
<icons>font</icons>
|
||||
<pagenums/>
|
||||
<toc/>
|
||||
<idprefix/>
|
||||
<idseparator>-</idseparator>
|
||||
</attributes>
|
||||
<sourceDirectory>${basedir}/src/main/asciidoc/quickstart-distribution-guide</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<outputFile>${project.build.directory}/pdf/quickstart-distribution-guide/quickstart-distribution-guide.pdf</outputFile>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>contribution-guide-epub</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>epub3</backend>
|
||||
<sourceHighlighter>coderay</sourceHighlighter>
|
||||
<sourceDirectory>${basedir}/src/main/asciidoc/contribution-guide</sourceDirectory>
|
||||
<sourceDocumentName>index.adoc</sourceDocumentName>
|
||||
<outputFile>${project.build.directory}/epub/contribution-guide/contribution-guide.epub</outputFile>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 140 KiB After Width: | Height: | Size: 140 KiB |
|
Before Width: | Height: | Size: 431 KiB After Width: | Height: | Size: 431 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 329 KiB After Width: | Height: | Size: 329 KiB |
|
Before Width: | Height: | Size: 441 KiB After Width: | Height: | Size: 441 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 300 KiB After Width: | Height: | Size: 300 KiB |
|
Before Width: | Height: | Size: 136 KiB After Width: | Height: | Size: 136 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue