Skip to content

Commit 7465414

Browse files
committed
Migrate docs to Antora.
Closes #1427
1 parent 66de8a8 commit 7465414

File tree

94 files changed

+2456
-2412
lines changed

Some content is hidden

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

94 files changed

+2456
-2412
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,9 @@ build
1515
.idea
1616
download
1717
work
18+
build/
19+
node_modules
20+
node
21+
package.json
22+
package-lock.json
1823

spring-data-cassandra-distribution/pom.xml

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,40 @@
1515
<artifactId>spring-data-cassandra-distribution</artifactId>
1616
<packaging>pom</packaging>
1717

18-
<name>Spring Data for Apache Cassandra - Distribution</name>
19-
<description>Distribution build for Spring Data for Apache Cassandra</description>
20-
<url>https://github.com/spring-projects/spring-data-cassandra/tree/master/spring-data-cassandra-distribution</url>
21-
2218
<properties>
2319
<project.root>${basedir}/..</project.root>
24-
<dist.key>SDCASS</dist.key>
20+
<antora.playbook>${project.basedir}/../src/main/antora/antora-playbook.yml</antora.playbook>
2521
</properties>
2622

2723
<build>
24+
<resources>
25+
<resource>
26+
<directory>${project.basedir}/../src/main/antora/resources/antora-resources</directory>
27+
<filtering>true</filtering>
28+
</resource>
29+
</resources>
2830
<plugins>
31+
<plugin>
32+
<groupId>org.apache.maven.plugins</groupId>
33+
<artifactId>maven-resources-plugin</artifactId>
34+
<executions>
35+
<execution>
36+
<goals>
37+
<goal>resources</goal>
38+
</goals>
39+
</execution>
40+
</executions>
41+
42+
</plugin>
43+
2944
<plugin>
3045
<groupId>org.apache.maven.plugins</groupId>
3146
<artifactId>maven-assembly-plugin</artifactId>
3247
</plugin>
48+
3349
<plugin>
34-
<groupId>org.asciidoctor</groupId>
35-
<artifactId>asciidoctor-maven-plugin</artifactId>
50+
<groupId>io.spring.maven.antora</groupId>
51+
<artifactId>antora-maven-plugin</artifactId>
3652
</plugin>
3753
</plugins>
3854
</build>
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-cassandra'
9+
site:
10+
title: Spring Data Cassandra
11+
url: https://docs.spring.io/spring-data-cassandra/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-cassandra
2+
version: true
3+
title: Spring Data Cassandra
4+
nav:
5+
- modules/ROOT/nav.adoc
6+
ext:
7+
collector:
8+
- run:
9+
command: ./mvnw validate process-resources -pl :spring-data-cassandra-distribution -am -Pantora-process-resources
10+
local: true
11+
scan:
12+
dir: spring-data-cassandra-distribution/target/classes/

0 commit comments

Comments
 (0)