#828 - Backport modernized docs.

Original issue: #798.
This commit is contained in:
Greg Turnquist
2019-02-20 13:01:22 -06:00
committed by Oliver Drotbohm
parent 77392de587
commit 3346005bf6
2 changed files with 57 additions and 19 deletions

65
pom.xml
View File

@@ -13,7 +13,7 @@
hyper-text driven REST web services.
</description>
<inceptionYear>2012-2018</inceptionYear>
<inceptionYear>2012-2019</inceptionYear>
<organization>
<name>Pivotal, Inc.</name>
@@ -211,6 +211,7 @@
<maven.install.skip>true</maven.install.skip>
<skipTests>true</skipTests>
<project.root>${basedir}</project.root>
<docs.resources.version>0.1.0.RELEASE</docs.resources.version>
</properties>
<dependencies>
@@ -221,6 +222,13 @@
<scope>provided</scope>
<type>zip</type>
</dependency>
<dependency>
<groupId>io.spring.docresources</groupId>
<artifactId>spring-doc-resources</artifactId>
<version>${docs.resources.version}</version>
<type>zip</type>
<optional>true</optional>
</dependency>
</dependencies>
<build>
@@ -242,6 +250,20 @@
</goals>
<phase>generate-resources</phase>
</execution>
<execution>
<id>unpack-doc-resources</id>
<goals>
<goal>unpack-dependencies</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<includeGroupIds>io.spring.docresources</includeGroupIds>
<includeArtifactIds>spring-doc-resources</includeArtifactIds>
<includeTypes>zip</includeTypes>
<excludeTransitive>true</excludeTransitive>
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
</configuration>
</execution>
</executions>
<configuration>
<includeGroupIds>org.springframework.data</includeGroupIds>
@@ -270,6 +292,29 @@
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-asciidoc-resources</id>
<phase>generate-resources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
<resources>
<resource>
<directory>src/main/asciidoc</directory>
<filtering>false</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
@@ -291,14 +336,18 @@
</goals>
<configuration>
<backend>html5</backend>
<sourceHighlighter>highlight.js</sourceHighlighter>
<outputDirectory>${project.build.directory}/site/reference/html</outputDirectory>
<sectids>false</sectids>
<sourceHighlighter>prettify</sourceHighlighter>
<attributes>
<docinfo>shared</docinfo>
<linkcss>true</linkcss>
<icons>font</icons>
<sectanchors>true</sectanchors>
<stylesdir>css/</stylesdir>
<stylesheet>spring.css</stylesheet>
<highlightjsdir>js/highlight</highlightjsdir>
<highlightjs-theme>atom-one-dark-reasonable</highlightjs-theme>
</attributes>
</configuration>
</execution>
@@ -318,15 +367,14 @@
</executions>
<configuration>
<sourceDirectory>${project.root}/src/main/asciidoc</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<sourceDirectory>${project.build.directory}/refdocs/</sourceDirectory>
<doctype>book</doctype>
<attributes>
<version>${project.version}</version>
<projectName>${project.name}</projectName>
<projectVersion>${project.version}</projectVersion>
<allow-uri-read>true</allow-uri-read>
<toclevels>3</toclevels>
<toclevels>4</toclevels>
<numbered>true</numbered>
<baseDir>${project.basedir}</baseDir>
</attributes>
@@ -344,12 +392,6 @@
<phase>generate-resources</phase>
<configuration>
<target>
<copy todir="${project.root}/target/site/reference/html">
<fileset dir="${shared.resources}/asciidoc" erroronmissingdir="false">
<include name="**/*.css" />
</fileset>
<flattenmapper />
</copy>
<copy todir="${project.root}/target/site/reference/html/images">
<fileset dir="${basedir}/src/main/asciidoc" erroronmissingdir="false">
<include name="**/*.png" />
@@ -371,7 +413,6 @@
<configuration>
<target>
<copy file="${project.build.directory}/generated-docs/index.pdf" tofile="${project.root}/target/site/reference/pdf/${project.artifactId}-reference.pdf" failonerror="false" />
<copy file="${project.build.directory}/generated-docs/index.epub" tofile="${project.root}/target/site/reference/epub/${project.artifactId}-reference.epub" failonerror="false" />
</target>
</configuration>
<goals>

View File

@@ -1,19 +1,16 @@
= Spring HATEOAS - Reference Documentation
Oliver Gierke, Greg Turnquist;
Oliver Gierke; Greg Turnquist; Jay Bryant
:revnumber: {version}
:revdate: {localdate}
:toc:
:toc-placement!:
:toc: left
:hide-uri-scheme:
This project provides some APIs to ease creating REST representations that follow the http://en.wikipedia.org/wiki/HATEOAS[HATEOAS] principle when working with Spring and especially Spring MVC. The core problem it tries to address is link creation and representation assembly.
(C) 2012-2015 The original authors.
(C) 2012-2019 The original authors.
NOTE: Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
toc::[]
[[fundamentals]]
== Fundmentals