Skip to content

Commit 3b762c0

Browse files
committed
Migrate documentation to Antora.
Closes #2304
1 parent 1ea9c99 commit 3b762c0

39 files changed

+215
-104
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,7 @@ target/
1212
vf.gf.*
1313
out/
1414
_site
15+
node_modules
16+
package-lock.json
17+
package.json
18+
node

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The goal of the project is to provide a flexible and configurable mechanism for writing simple services that can be exposed over HTTP.
44

5-
The first exporter implemented is a JPA Repository exporter. This takes your JPA repositories and front-ends them with HTTP, allowing you full CRUD capability over your entities, to include managing associations.
5+
This takes your Spring Data repositories and front-ends them with HTTP, allowing you full CRUD capability over your entities, to include managing associations.
66

77
== Features
88

@@ -15,7 +15,7 @@ The first exporter implemented is a JPA Repository exporter. This takes your JPA
1515
* https://docs.spring.io/spring-data/rest/docs/current/reference/html/#metadata[Exposes metadata] about the model discovered as ALPS and JSON Schema.
1616
* Allows to define client specific representations through https://docs.spring.io/spring-data/rest/docs/current/reference/html/#projections-excerpts[projections].
1717
* Ships the latest release of https://docs.spring.io/spring-data/rest/docs/current/reference/html/#tools.hal-explorer[HAL Explorer] to easily explore HAL and HAL-FORMS based HTTP responses.
18-
* Currently supports JPA, MongoDB, Neo4j, Solr, Cassandra, Gemfire.
18+
* Supports JPA, MongoDB, Neo4j, Solr, Cassandra, Gemfire.
1919
* Allows https://docs.spring.io/spring-data/rest/docs/current/reference/html/#customizing-sdr[advanced customizations] of the default resources exposed.
2020

2121
== Code of Conduct

spring-data-rest-distribution/pom.xml

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,38 @@
1919

2020
<properties>
2121
<project.root>${basedir}/..</project.root>
22-
<dist.key>SDREST</dist.key>
22+
<antora.playbook>${project.basedir}/../src/main/antora/antora-playbook.yml</antora.playbook>
2323
</properties>
2424

2525
<build>
26+
<resources>
27+
<resource>
28+
<directory>${project.basedir}/../src/main/antora/resources/antora-resources</directory>
29+
<filtering>true</filtering>
30+
</resource>
31+
</resources>
2632
<plugins>
2733
<plugin>
2834
<groupId>org.apache.maven.plugins</groupId>
2935
<artifactId>maven-assembly-plugin</artifactId>
3036
</plugin>
37+
38+
<plugin>
39+
<groupId>org.apache.maven.plugins</groupId>
40+
<artifactId>maven-resources-plugin</artifactId>
41+
<executions>
42+
<execution>
43+
<goals>
44+
<goal>resources</goal>
45+
</goals>
46+
</execution>
47+
</executions>
48+
49+
</plugin>
50+
3151
<plugin>
32-
<groupId>org.asciidoctor</groupId>
33-
<artifactId>asciidoctor-maven-plugin</artifactId>
52+
<groupId>io.spring.maven.antora</groupId>
53+
<artifactId>antora-maven-plugin</artifactId>
3454
</plugin>
3555
</plugins>
3656
</build>
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2
2+
#
3+
# The purpose of this Antora playbook is to build the docs in the current branch.
4+
antora:
5+
extensions:
6+
- '@antora/collector-extension'
7+
- require: '@springio/antora-extensions/root-component-extension'
8+
root_component_name: 'data-rest'
9+
site:
10+
title: Spring Data REST
11+
url: https://docs.spring.io/spring-data-rest/reference/
12+
content:
13+
sources:
14+
- url: ./../../..
15+
branches: HEAD
16+
start_path: src/main/antora
17+
worktrees: true
18+
asciidoc:
19+
attributes:
20+
page-pagination: ''
21+
hide-uri-scheme: '@'
22+
tabs-sync-option: '@'
23+
chomp: 'all'
24+
extensions:
25+
- '@asciidoctor/tabs'
26+
- '@springio/asciidoctor-extensions'
27+
sourcemap: true
28+
urls:
29+
latest_version_segment: ''
30+
runtime:
31+
log:
32+
failure_level: warn
33+
format: pretty
34+
ui:
35+
bundle:
36+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.5/ui-bundle.zip
37+
snapshot: true

src/main/antora/antora.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: data-rest
2+
version: true
3+
title: Spring Data REST
4+
nav:
5+
- modules/ROOT/nav.adoc
6+
ext:
7+
collector:
8+
- run:
9+
command: ./mvnw validate process-resources -pl :spring-data-rest-distribution -am -Pantora-process-resources
10+
local: true
11+
scan:
12+
dir: spring-data-rest-distribution/target/classes/
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../../../spring-data-rest-tests/spring-data-rest-tests-mongodb/src/main/java/org/springframework/data/rest/tests/mongodb
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../../../spring-data-rest-tests/spring-data-rest-tests-security/src/test/java/org/springframework/data/rest/tests/security
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../../../spring-data-rest-webmvc/src/test/java/org/springframework/data/rest/webmvc/support
43.4 KB
Loading
13.9 KB
Loading

0 commit comments

Comments
 (0)