Skip to content

Commit

Permalink
Migrate documentation to Antora.
Browse files Browse the repository at this point in the history
Closes #1597
  • Loading branch information
mp911de committed Aug 31, 2023
1 parent f71b41f commit 4202b09
Show file tree
Hide file tree
Showing 78 changed files with 1,934 additions and 2,092 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ target/
*.graphml
*.json

build/
node_modules
node

#prevent license accepting file to get accidentially commited to git
container-license-acceptance.txt
spring-data-jdbc/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java
spring-data-r2dbc/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java
spring-data-r2dbc/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java
4 changes: 2 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,10 @@ Building the documentation builds also the project without running tests.

[source,bash]
----
$ ./mvnw clean install -Pdistribute
$ ./mvnw clean install -Pantora
----

The generated documentation is available from `target/site/reference/html/index.html`.
The generated documentation is available from `spring-data-jdbc-distribution/target/antora/site/index.html`.

== Modules

Expand Down
23 changes: 19 additions & 4 deletions spring-data-jdbc-distribution/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,33 @@

<properties>
<project.root>${basedir}/..</project.root>
<dist.key>SDJDBC</dist.key>
<antora.playbook>${project.basedir}/../src/main/antora/antora-playbook.yml</antora.playbook>
</properties>

<build>
<resources>
<resource>
<directory>${project.basedir}/../src/main/antora/resources/antora-resources</directory>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>resources</goal>
</goals>
</execution>
</executions>

</plugin>

<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<groupId>io.spring.maven.antora</groupId>
<artifactId>antora-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
Expand Down
54 changes: 0 additions & 54 deletions spring-data-r2dbc/src/main/asciidoc/index.adoc

This file was deleted.

122 changes: 0 additions & 122 deletions spring-data-r2dbc/src/main/asciidoc/preface.adoc

This file was deleted.

10 changes: 0 additions & 10 deletions spring-data-r2dbc/src/main/asciidoc/reference/introduction.adoc

This file was deleted.

Loading

0 comments on commit 4202b09

Please sign in to comment.