Spring/spring-hateoas
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#798 - Modernize documentation production and appearance.

Browse Source 
Applied new convention standard for generating documentation using spring-doc-resources.
This commit is contained in:
Jay Bryant
2019-02-05 13:11:44 -06:00
committed by Greg Turnquist
parent 952422b4e5
commit a483daab6d
3 changed files with 99 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
pom.xml
View File

@@ -184,6 +184,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>
@@ -194,6 +195,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>
@@ -215,6 +223,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>
@@ -243,6 +265,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>
@@ -264,14 +309,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>
@@ -291,15 +340,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>
@@ -317,12 +365,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" />
@@ -344,7 +386,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>

9
src/main/asciidoc/index.adoc
View File

@@ -2,18 +2,15 @@
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]]
== Fundamentals

44
src/main/resources/changelog.txt
View File

@@ -1,6 +1,50 @@
Spring HATEOAS Changelog
========================
Changes in version 0.25.0.RELEASE (2018-07-25)
----------------------------------------------
- #730 - Release 0.25.
- #724 - Ensure Spring 4.3 / 5 compatibility in EncodingUtils.
- #723 - Backport simplified configuration setup.
- #722 - Update build plugins.
- #721 - Upgrade to Lombok 1.18.0.
- #720 - Upgrade to Spring 4.3.18.
- #665 - ALPS spec name is "descriptor" not "descriptors".
Changes in version 0.24.0.RELEASE (2017-10-30)
----------------------------------------------
- #661 - Release 0.24.
- #658 - Remove unused Enhancer variable.
- #639 - Add support for Optional parameters in ControllerLinkBuilder.
- #638 - Fix typos in Javadoc.
- #635 - Upgrade Spring Framework 5 build profile to 5.0 GA.
- #623 - Upgrade Spring 5 build profile to Jackson 2.9.1.
- #621 - #617 - Use SynthesizingMethodParameter to support AliasFor attributes.
- #617 - Parameter names not detected in case @AliasFor'ed attributes are used.
- #604 - Make JacksonSerializationTest platform independent.
- #603 - Fix typos.
- #601 - #597 - Add ALPS mediatype and LinkDiscoverer.
- #600 - Fix typo in UriTemplate.
- #597 - Migrate ALPS media type and LinkDiscoverer from Spring Data REST.
- #594 - Guard against Spring 5's Not Nullable policy.
- #586 - #585 - Add script to run ALL build profiles.
- #585 - Make it easier to test all profiles.
- #584 - #580 - Update IANA relation types.
- #583 - Make sure build profile for Spring 5 uses compatible Jackson version.
- #582 - LinkBuilderSupport.slash(…) fails to append path segments with a colon.
- #580 - Update IANA relation types.
- #575 - spring5-next profile breaks Spring HATEOAS.
- #567 - Add extra attributes to Link and use for HAL mediatype.
- #564 - Add license file to the project.
- #558 - HypermediaSupportBeanDefinitionRegistrar double registers message converters.
- #557 - Update "JSON" to "Jackson" in reference docs.
- #555 - Fixed syntax highlighting and content of a few code blocks in the reference guide.
- #553 - Fix typo in build file.
- #552 - Upgrade Spring 5 next to M5.
- #542 - "Get Link functionality" of ResourceSupport class.
- #538 - Update location of static resources.
Changes in version 0.23.0.RELEASE (2016-12-22)
----------------------------------------------
- #529 - Release 0.23.