Migrate documentation to Antora

.gitignore

@@ -25,3 +25,8 @@ out
 
 /.gradletasknamecache
 **/*.flattened-pom.xml
+
+node
+node_modules
+package-lock.json
+package.json

spring-batch-docs/.github/workflows/deploy-docs.yml

@@ -0,0 +1,33 @@
+name: Deploy Docs
+on:
+  push:
+    branches-ignore: [ gh-pages ]
+    tags: '**'
+  repository_dispatch:
+    types: request-build-reference # legacy
+  #schedule:
+  #- cron: '0 10 * * *' # Once per day at 10am UTC
+  workflow_dispatch:
+permissions:
+  actions: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    # FIXME enable when pushed to spring-projects
+    # if: github.repository_owner == 'spring-projects'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: docs-build
+          fetch-depth: 1
+      - name: Dispatch (partial build)
+        if: github.ref_type == 'branch'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD) -f build-refname=${{ github.ref_name }}
+      - name: Dispatch (full build)
+        if: github.ref_type == 'tag'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD)

spring-batch-docs/antora-playbook.yml

@@ -0,0 +1,40 @@
+# 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:
+    - '@springio/antora-extensions/partial-build-extension'
+    - require: '@springio/antora-extensions/inject-collector-cache-config-extension'
+    - '@antora/collector-extension'
+    - '@antora/atlas-extension'
+    - require: '@springio/antora-extensions/root-component-extension'
+      root_component_name: 'batch'
+site:
+  title: Spring Batch Reference
+  url: https://docs.spring.io/spring-batch/reference
+content:
+  sources:
+    - url: ..
+      branches: HEAD
+      start_path: spring-batch-docs
+      worktrees: true
+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.3/ui-bundle.zip
+    snapshot: true

spring-batch-docs/antora.yml

@@ -0,0 +1,11 @@
+name: batch
+version: true
+title: Spring Batch Documentation
+nav:
+  - modules/ROOT/nav.adoc
+ext:
+  collector:
+    run:
+      command: mvn process-resources -pl spring-batch-docs -am
+    scan:
+      dir: ./target/classes/antora-resources

spring-batch-docs/modules/ROOT/nav.adoc

@@ -0,0 +1,62 @@
+* xref:index.adoc[]
+* xref:spring-batch-intro.adoc[]
+* xref:spring-batch-architecture.adoc[]
+* xref:whatsnew.adoc[]
+* xref:domain.adoc[]
+* xref:job.adoc[]
+** xref:job/configuring.adoc[]
+** xref:job/java-config.adoc[]
+** xref:job/configuring-repository.adoc[]
+** xref:job/configuring-launcher.adoc[]
+** xref:job/running.adoc[]
+** xref:job/advanced-meta-data.adoc[]
+* xref:step.adoc[]
+** xref:step/chunk-oriented-processing.adoc[]
+*** xref:step/chunk-oriented-processing/configuring.adoc[]
+*** xref:step/chunk-oriented-processing/inheriting-from-parent.adoc[]
+*** xref:step/chunk-oriented-processing/commit-interval.adoc[]
+*** xref:step/chunk-oriented-processing/restart.adoc[]
+*** xref:step/chunk-oriented-processing/configuring-skip.adoc[]
+*** xref:step/chunk-oriented-processing/retry-logic.adoc[]
+*** xref:step/chunk-oriented-processing/controlling-rollback.adoc[]
+*** xref:step/chunk-oriented-processing/transaction-attributes.adoc[]
+*** xref:step/chunk-oriented-processing/registering-item-streams.adoc[]
+*** xref:step/chunk-oriented-processing/intercepting-execution.adoc[]
+** xref:step/tasklet.adoc[]
+** xref:step/controlling-flow.adoc[]
+** xref:step/late-binding.adoc[]
+* xref:readersAndWriters.adoc[]
+** xref:readers-and-writers/item-reader.adoc[]
+** xref:readers-and-writers/item-writer.adoc[]
+** xref:readers-and-writers/item-stream.adoc[]
+** xref:readers-and-writers/delegate-pattern-registering.adoc[]
+** xref:readers-and-writers/flat-files.adoc[]
+*** xref:readers-and-writers/flat-files/field-set.adoc[]
+*** xref:readers-and-writers/flat-files/file-item-reader.adoc[]
+*** xref:readers-and-writers/flat-files/file-item-writer.adoc[]
+** xref:readers-and-writers/xml-reading-writing.adoc[]
+** xref:readers-and-writers/json-reading-writing.adoc[]
+** xref:readers-and-writers/multi-file-input.adoc[]
+** xref:readers-and-writers/database.adoc[]
+** xref:readers-and-writers/reusing-existing-services.adoc[]
+** xref:readers-and-writers/process-indicator.adoc[]
+** xref:readers-and-writers/custom.adoc[]
+** xref:readers-and-writers/item-reader-writer-implementations.adoc[]
+* xref:processor.adoc[]
+* xref:scalability.adoc[]
+* xref:repeat.adoc[]
+* xref:retry.adoc[]
+* xref:testing.adoc[]
+* xref:common-patterns.adoc[]
+* xref:spring-batch-integration.adoc[]
+** xref:spring-batch-integration/namespace-support.adoc[]
+** xref:spring-batch-integration/launching-jobs-through-messages.adoc[]
+** xref:spring-batch-integration/available-attributes-of-the-job-launching-gateway.adoc[]
+** xref:spring-batch-integration/sub-elements.adoc[]
+* xref:monitoring-and-metrics.adoc[]
+* xref:tracing.adoc[]
+* Appendices
+** xref:appendix.adoc[]
+** xref:schema-appendix.adoc[]
+** xref:transaction-appendix.adoc[]
+** xref:glossary.adoc[]

spring-batch-docs/src/main/asciidoc/appendix.adoc → spring-batch-docs/modules/ROOT/pages/appendix.adoc

@@ -1,14 +1,12 @@
-:toc: left
-:toclevels: 4
 
 [[listOfReadersAndWriters]]
-include::attributes.adoc[]
 
 [appendix]
-== List of ItemReaders and ItemWriters
+[[list-of-itemreaders-and-itemwriters]]
+= List of ItemReaders and ItemWriters
 
 [[itemReadersAppendix]]
-=== Item Readers
+== Item Readers
 
 .Available Item Readers
 [options="header"]
@@ -77,7 +75,7 @@ This reader stores message offsets in the execution context to support restart c
 
 
 [[itemWritersAppendix]]
-=== Item Writers
+== Item Writers
 
 .Available Item Writers
 [options="header"]