Migrate docs to Antora.

Closes #1427

Author: mp911de

.gitignore

@@ -15,4 +15,9 @@ build
 .idea
 download
 work
+build/
+node_modules
+node
+package.json
+package-lock.json
 

spring-data-cassandra-distribution/pom.xml

@@ -15,24 +15,40 @@
 	<artifactId>spring-data-cassandra-distribution</artifactId>
 	<packaging>pom</packaging>
 
-	<name>Spring Data for Apache Cassandra - Distribution</name>
-	<description>Distribution build for Spring Data for Apache Cassandra</description>
-	<url>https://github.com/spring-projects/spring-data-cassandra/tree/master/spring-data-cassandra-distribution</url>
-
 	<properties>
 		<project.root>${basedir}/..</project.root>
-		<dist.key>SDCASS</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-resources-plugin</artifactId>
+				<executions>
+					<execution>
+						<goals>
+							<goal>resources</goal>
+						</goals>
+					</execution>
+				</executions>
+
+			</plugin>
+
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-assembly-plugin</artifactId>
 			</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>

src/main/antora/antora-playbook.yml

@@ -0,0 +1,42 @@
+# PACKAGES [email protected] @antora/atlas-extension:1.0.0-alpha.1 @antora/[email protected] @springio/[email protected] @asciidoctor/[email protected] @opendevise/[email protected]
+#
+# The purpose of this Antora playbook is to build the docs in the current branch.
+antora:
+  extensions:
+    - '@antora/collector-extension'
+    - require: '@springio/antora-extensions/root-component-extension'
+      root_component_name: 'data-cassandra'
+site:
+  title: Spring Data Cassandra
+  url: https://docs.spring.io/spring-data-cassandra/reference/
+content:
+  sources:
+    - url: ./../../..
+      branches: HEAD
+      start_path: src/main/antora
+      worktrees: true
+    - url: https://github.com/spring-projects/spring-data-commons
+      # Refname matching:
+      # https://docs.antora.org/antora/latest/playbook/content-refname-matching/
+      branches: [ main, 3.2.x ]
+      start_path: src/main/antora
+asciidoc:
+  attributes:
+    page-pagination: ''
+    hide-uri-scheme: '@'
+    tabs-sync-option: '@'
+    chomp: 'all'
+  extensions:
+    - '@asciidoctor/tabs'
+    - '@springio/asciidoctor-extensions'
+  sourcemap: true
+urls:
+  latest_version_segment: ''
+runtime:
+  log:
+    failure_level: warn
+    format: pretty
+ui:
+  bundle:
+    url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.5/ui-bundle.zip
+    snapshot: true

src/main/antora/antora.yml

@@ -0,0 +1,12 @@
+name: data-cassandra
+version: true
+title: Spring Data Cassandra
+nav:
+  - modules/ROOT/nav.adoc
+ext:
+  collector:
+    - run:
+        command: ./mvnw validate process-resources -pl :spring-data-cassandra-distribution -am -Pantora-process-resources
+        local: true
+      scan:
+        dir: spring-data-cassandra-distribution/target/classes/

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/example/AppConfig.java renamed to src/main/antora/modules/ROOT/examples/AppConfig.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2020-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https:://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.cassandra.example;
+
+import static org.springframework.data.cassandra.core.query.Criteria.*;
+import static org.springframework.data.cassandra.core.query.Query.*;
+
+import org.springframework.data.cassandra.core.CassandraTemplate;
+
+import com.datastax.oss.driver.api.core.cql.SimpleStatement;
+
+/**
+ * @author Mark Paluch
+ */
+// @formatter:off
+public class ReactiveCassandraTemplateExamples {
+
+	private ReactiveCassandraTemplate template = null;
+
+	void examples() {
+		// tag::preparedStatement[]
+		template.setUsePreparedStatements(true);
+
+		Mono<Actor> actorByQuery = template.selectOne(query(where("id").is(42)), Actor.class);
+
+		Mono<Actor> actorByStatement = template.selectOne(
+				SimpleStatement.newInstance("SELECT id, name FROM actor WHERE id = ?", 42),
+				Actor.class);
+		// end::preparedStatement[]
+	}
+
+	static class Actor {
+
+	}
+
+}

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/example/CassandraApplication.java renamed to src/main/antora/modules/ROOT/examples/CassandraApplication.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2020-2023 the original author or authors.
+ * Copyright 2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      https:://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -73,6 +73,13 @@ public Actor mapRow(Row row, int rowNum) {
 				}
 		});
 		// end::listOfRowMapper[]
+
+		// tag::preparedStatement[]
+		Flux<String> lastNames = reactiveCqlTemplate.query(
+				session -> session.prepare("SELECT last_name FROM t_actor WHERE id = ?"),
+				ps -> ps.bind(1212L),
+				(row, rowNum) -> row.getString(0));
+		// end::preparedStatement[]
 	}
 
 	// tag::findAllActors[]

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/example/CassandraConfig.java renamed to src/main/antora/modules/ROOT/examples/CassandraConfig.java

@@ -0,0 +1,45 @@
+* xref:index.adoc[Overview]
+** xref:commons/upgrade.adoc[]
+
+* xref:cassandra.adoc[]
+** xref:cassandra/getting-started.adoc[]
+** xref:cassandra/configuration.adoc[]
+** xref:cassandra/schema-management.adoc[]
+** xref:cassandra/cql-template.adoc[]
+** xref:cassandra/reactive-cassandra.adoc[]
+** xref:cassandra/template.adoc[]
+** xref:cassandra/prepared-statements.adoc[]
+** xref:object-mapping.adoc[]
+** xref:cassandra/converters.adoc[]
+** xref:cassandra/events.adoc[]
+** xref:cassandra/auditing.adoc[]
+
+* xref:repositories.adoc[]
+** xref:repositories/core-concepts.adoc[]
+** xref:repositories/definition.adoc[]
+** xref:cassandra/repositories/repositories.adoc[]
+** xref:repositories/create-instances.adoc[]
+** xref:repositories/query-methods-details.adoc[]
+** xref:cassandra/repositories/query-methods.adoc[]
+** xref:repositories/projections.adoc[]
+** xref:repositories/custom-implementations.adoc[]
+** xref:repositories/core-domain-events.adoc[]
+** xref:repositories/null-handling.adoc[]
+** xref:cassandra/repositories/cdi-integration.adoc[]
+** xref:repositories/query-keywords-reference.adoc[]
+** xref:repositories/query-return-types-reference.adoc[]
+
+* xref:observability.adoc[]
+
+* xref:kotlin.adoc[]
+** xref:kotlin/requirements.adoc[]
+** xref:kotlin/null-safety.adoc[]
+** xref:kotlin/object-mapping.adoc[]
+** xref:kotlin/extensions.adoc[]
+** xref:kotlin/coroutines.adoc[]
+
+* xref:migration-guides.adoc[]
+** xref:migration-guide/migration-guide-1.5-to-2.0.adoc[]
+** xref:migration-guide/migration-guide-2.2-to-3.0.adoc[]
+** xref:migration-guide/migration-guide-3.0-to-4.0.adoc[]
+* https://github.com/spring-projects/spring-data-commons/wiki[Wiki]

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/example/CassandraConfiguration.java renamed to src/main/antora/modules/ROOT/examples/CassandraConfiguration.java

@@ -0,0 +1,17 @@
+[[cassandra.core]]
+= Cassandra Support
+:page-section-summary-toc: 1
+
+Spring Data support for Apache Cassandra contains a wide range of features:
+
+* Spring configuration support with Java-based `@Configuration` classes or the XML namespace.
+* The `CqlTemplate`, `AsyncCqlTemplate`, and `ReactiveCqlTemplate` helper classes that increases productivity by properly handling common Cassandra data access operations.
+* The `CassandraTemplate`, `AsyncCassandraTemplate`, and `ReactiveCassandraTemplate` helper classes that provide object mapping between CQL Tables and POJOs.
+* Exception translation into Spring's portable {springDocsUrl}data-access.html#dao-exceptions[Data Access Exception Hierarchy].
+* Feature rich object mapping integrated with _Spring's_ {springDocsUrl}core.html#core-convert[Conversion Service].
+* Annotation-based mapping metadata that is extensible to support other metadata formats.
+* Java-based query, criteria, and update DSLs.
+* Automatic implementation of imperative and reactive `Repository` interfaces including support for custom finder methods.
+
+For most data-oriented tasks, you can use the `[Reactive|Async]CassandraTemplate` or the `Repository` support, both of which use the rich object-mapping functionality. `[Reactive|Async]CqlTemplate` is commonly used to increment counters or perform ad-hoc CRUD operations. `[Reactive|Async]CqlTemplate` also provides callback methods that make it easy to get low-level API objects, such as `com.datastax.oss.driver.api.core.CqlSession`, which lets you communicate directly with Cassandra.
+Spring Data for Apache Cassandra uses consistent naming conventions on objects in various APIs to those found in the DataStax Java Driver so that they are familiar and so that you can map your existing knowledge onto the Spring APIs.

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/example/CassandraTemplateExamples.java renamed to src/main/antora/modules/ROOT/examples/CassandraTemplateExamples.java

@@ -1,12 +1,14 @@
 [[cassandra.auditing]]
-== General Auditing Configuration for Cassandra
+= Auditing Configuration for Cassandra
 
 To activate auditing functionality, create a configuration as the following example shows:
 
-.Activating auditing by using XML configuration
-====
-.Java
-[source,java,role="primary"]
+.Activating auditing through configuration
+[tabs]
+======
+Java::
++
+[source,java,indent=0,subs="verbatim,quotes",role="primary"]
 ----
 @Configuration
 @EnableCassandraAuditing
@@ -19,8 +21,9 @@ class Config {
 }
 ----
 
-.XML
-[source,xml,role="secondary"]
+XML::
++
+[source,xml,indent=0,subs="verbatim,quotes",role="secondary"]
 ----
 <?xml version="1.0" encoding="UTF-8"?>
 <beans xmlns="http://www.springframework.org/schema/beans"
@@ -35,7 +38,7 @@ class Config {
     <cassandra:auditing mapping-context-ref="customMappingContext" auditor-aware-ref="yourAuditorAwareImpl"/>
 </beans>
 ----
-====
+======
 
 If you expose a bean of type `AuditorAware` to the `ApplicationContext`, the auditing infrastructure picks it up automatically and uses it to determine the current user to be set on domain types.
 If you have multiple implementations registered in the `ApplicationContext`, you can select the one to be used by explicitly setting the `auditorAwareRef` attribute of `@EnableCassandraAuditing`.