Skip to content

Commit 670dec5

Browse files
meistermeiermeistermeier
committed
Migrate documentation to Antora.
1 parent 2bc92b7 commit 670dec5

Some content is hidden

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

66 files changed

+977
-888
lines changed

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,10 @@ target/
3232
.flattened-pom.xml
3333
dependency-reduced-pom.xml
3434
.gradle
35+
36+
build/
37+
node_modules
38+
node
39+
package.json
40+
package-lock.json
41+

‎README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,14 +146,14 @@ class MyService {
146146

147147
=== Building SDN
148148

149-
Please have a look at the documentation: https://docs.spring.io/spring-data/neo4j/docs/current/reference/html/#building-sdn-rx[Building SDN].
149+
Please have a look at the documentation: https://docs.spring.io/spring-data/neo4j/reference/#building-sdn-rx[Building SDN].
150150

151151
== Getting Help
152152

153153
Having trouble with Spring Data? We’d love to help!
154154

155155
* Check the
156-
https://docs.spring.io/spring-data/neo4j/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/neo4j/docs/current/api/[Javadocs].
156+
https://docs.spring.io/spring-data/neo4j/reference/[reference documentation], and https://docs.spring.io/spring-data/neo4j/docs/current/api/[Javadocs].
157157
* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
158158
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
159159
* If you are upgrading, check out the https://docs.spring.io/spring-data/neo4j/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features.
@@ -166,7 +166,7 @@ Spring Data uses GitHub as issue tracking system to record bugs and feature requ
166166

167167
* Before you log a bug, please search the
168168
https://github.com/spring-projects/spring-data-neo4j/issues[issue tracker] to see if someone has already reported the problem.
169-
* If the issue doesn’t already exist, https://github.com/spring-projects/spring-data-neo4j/issues/new[create a new issue].
169+
* If the issue doesn't already exist, https://github.com/spring-projects/spring-data-neo4j/issues/new[create a new issue].
170170
* Please provide as much information as possible with the issue report, we like to know the version of Spring Data Neo4j, the database version and the JVM version that you are using.
171171
* If you need to paste code, or include a stack trace use Markdown +++```+++ escapes before and after your text.
172172
* If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code.

‎pom.xml

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,9 @@
6868
</developers>
6969

7070
<properties>
71+
<antora.playbook>${project.basedir}/src/main/antora/antora-playbook.yml</antora.playbook>
7172
<apiguardian.version>1.1.1</apiguardian.version>
7273
<archunit.version>0.23.1</archunit.version>
73-
<asciidoctor-maven-plugin.version>2.1.0</asciidoctor-maven-plugin.version>
74-
<asciidoctorj-diagram.version>2.1.0</asciidoctorj-diagram.version>
7574
<blockhound.version>1.0.8.RELEASE</blockhound.version>
7675
<byte-buddy.version>1.14.3</byte-buddy.version>
7776
<cdi>3.0.1</cdi>
@@ -115,7 +114,6 @@
115114

116115
<skipUnitTests>${skipTests}</skipUnitTests>
117116

118-
<spring-data-commons-docs.dir>../../../../spring-data-commons/src/main/asciidoc</spring-data-commons-docs.dir>
119117
<springdata.commons>3.2.0-SNAPSHOT</springdata.commons>
120118
</properties>
121119

@@ -725,34 +723,41 @@
725723
</execution>
726724
</executions>
727725
</plugin>
726+
<plugin>
727+
<groupId>org.apache.maven.plugins</groupId>
728+
<artifactId>maven-resources-plugin</artifactId>
729+
<executions>
730+
<execution>
731+
<goals>
732+
<goal>resources</goal>
733+
</goals>
734+
</execution>
735+
</executions>
736+
</plugin>
728737
</plugins>
729738

730739
</build>
731740

732741
<profiles>
733742
<profile>
734-
<id>distribute</id>
743+
<id>antora-process-resources</id>
744+
<build>
745+
<resources>
746+
<resource>
747+
<directory>src/main/antora/resources/antora-resources</directory>
748+
<filtering>true</filtering>
749+
</resource>
750+
</resources>
751+
</build>
752+
</profile>
753+
754+
<profile>
755+
<id>antora</id>
735756
<build>
736757
<plugins>
737758
<plugin>
738-
<groupId>org.asciidoctor</groupId>
739-
<artifactId>asciidoctor-maven-plugin</artifactId>
740-
<version>${asciidoctor-maven-plugin.version}</version>
741-
<dependencies>
742-
<dependency>
743-
<groupId>org.asciidoctor</groupId>
744-
<artifactId>asciidoctorj-diagram</artifactId>
745-
<version>${asciidoctorj-diagram.version}</version>
746-
</dependency>
747-
</dependencies>
748-
<configuration combine.self="append">
749-
<attributes>
750-
<spring-data-commons-docs>${spring-data-commons-docs.dir}</spring-data-commons-docs>
751-
</attributes>
752-
<requires>
753-
<require>asciidoctor-diagram</require>
754-
</requires>
755-
</configuration>
759+
<groupId>io.spring.maven.antora</groupId>
760+
<artifactId>antora-maven-plugin</artifactId>
756761
</plugin>
757762
</plugins>
758763
</build>

‎src/main/antora/antora-playbook.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# PACKAGES [email protected] @antora/atlas-extension:1.0.0-alpha.1 @antora/[email protected] @springio/[email protected] @asciidoctor/[email protected] @opendevise/[email protected]
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-neo4j'
9+
site:
10+
title: Spring Data Neo4j
11+
url: https://docs.spring.io/spring-data/neo4j/reference/
12+
content:
13+
sources:
14+
- url: ./../../..
15+
branches: HEAD
16+
start_path: src/main/antora
17+
worktrees: true
18+
- url: https://github.com/spring-projects/spring-data-commons
19+
# Refname matching:
20+
# https://docs.antora.org/antora/latest/playbook/content-refname-matching/
21+
branches: [ main, 3.2.x ]
22+
start_path: src/main/antora
23+
asciidoc:
24+
attributes:
25+
page-pagination: ''
26+
hide-uri-scheme: '@'
27+
tabs-sync-option: '@'
28+
chomp: 'all'
29+
extensions:
30+
- '@asciidoctor/tabs'
31+
- '@springio/asciidoctor-extensions'
32+
sourcemap: true
33+
urls:
34+
latest_version_segment: ''
35+
runtime:
36+
log:
37+
failure_level: warn
38+
format: pretty
39+
ui:
40+
bundle:
41+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.5/ui-bundle.zip
42+
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-neo4j
2+
version: true
3+
title: Spring Data Neo4j
4+
nav:
5+
- modules/ROOT/nav.adoc
6+
ext:
7+
collector:
8+
- run:
9+
command: ./mvnw validate process-resources -am -Pantora-process-resources
10+
local: true
11+
scan:
12+
dir: target/classes/

‎src/main/antora/modules/ROOT/examples/config

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../java/org/springframework/data/neo4j/config

‎src/main/antora/modules/ROOT/examples/core

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../java/org/springframework/data/neo4j/core

‎src/main/antora/modules/ROOT/examples/documentation

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../../test/java/org/springframework/data/neo4j/documentation

‎src/main/antora/modules/ROOT/examples/integration

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../../test/java/org/springframework/data/neo4j/integration

‎src/main/antora/modules/ROOT/examples/repository

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../java/org/springframework/data/neo4j/repository

0 commit comments

Comments
 (0)