Skip to content

Commit 2e8d506

Browse files
rwinchfmbenhassine
authored andcommitted
Migrate documentation to Antora
Issue #4422
1 parent e36a447 commit 2e8d506

File tree

149 files changed

+9447
-9089
lines changed

Some content is hidden

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

149 files changed

+9447
-9089
lines changed

Diff for: .github/workflows/deploy-docs.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Deploy Docs
2+
on:
3+
push:
4+
branches-ignore: [ gh-pages ]
5+
tags: '**'
6+
repository_dispatch:
7+
types: request-build-reference # legacy
8+
workflow_dispatch:
9+
permissions:
10+
actions: write
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
if: github.repository_owner == 'spring-projects'
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v3
18+
with:
19+
ref: docs-build
20+
fetch-depth: 1
21+
- name: Dispatch (partial build)
22+
if: github.ref_type == 'branch'
23+
env:
24+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25+
run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD) -f build-refname=${{ github.ref_name }}
26+
- name: Dispatch (full build)
27+
if: github.ref_type == 'tag'
28+
env:
29+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
30+
run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD)

Diff for: .gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,8 @@ out
2525

2626
/.gradletasknamecache
2727
**/*.flattened-pom.xml
28+
29+
node
30+
node_modules
31+
package-lock.json
32+
package.json

Diff for: README.md

+2-3

Diff for: pom.xml

+1-3
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,7 @@
136136
<groovy.version>3.0.19</groovy.version>
137137

138138
<!-- documentation dependencies -->
139-
<asciidoctorj-pdf.version>1.6.2</asciidoctorj-pdf.version> <!-- FIXME build failure with version 2.3.9 -->
140-
<asciidoctorj-epub.version>1.5.1</asciidoctorj-epub.version>
141-
<spring-asciidoctor-backends.version>0.0.6</spring-asciidoctor-backends.version>
139+
<io.spring.maven.antora-version>0.0.3</io.spring.maven.antora-version>
142140

143141
<!-- plugin versions -->
144142
<maven-compiler-plugin.version>3.11.0</maven-compiler-plugin.version>

Diff for: spring-batch-docs/antora-playbook.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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+
- '@springio/antora-extensions/partial-build-extension'
7+
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
8+
- '@antora/collector-extension'
9+
- '@antora/atlas-extension'
10+
- require: '@springio/antora-extensions/root-component-extension'
11+
root_component_name: 'batch'
12+
site:
13+
title: Spring Batch Reference
14+
url: https://docs.spring.io/spring-batch/reference
15+
content:
16+
sources:
17+
- url: ..
18+
branches: HEAD
19+
start_path: spring-batch-docs
20+
worktrees: true
21+
asciidoc:
22+
attributes:
23+
page-pagination: ''
24+
hide-uri-scheme: '@'
25+
tabs-sync-option: '@'
26+
chomp: 'all'
27+
extensions:
28+
- '@asciidoctor/tabs'
29+
- '@springio/asciidoctor-extensions'
30+
sourcemap: true
31+
urls:
32+
latest_version_segment: ''
33+
runtime:
34+
log:
35+
failure_level: warn
36+
format: pretty
37+
ui:
38+
bundle:
39+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.3/ui-bundle.zip
40+
snapshot: true

Diff for: spring-batch-docs/antora.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: batch
2+
version: true
3+
title: Spring Batch Documentation
4+
nav:
5+
- modules/ROOT/nav.adoc
6+
ext:
7+
collector:
8+
run:
9+
command: mvn process-resources -pl spring-batch-docs -am
10+
scan:
11+
dir: ./target/classes/antora-resources

Diff for: spring-batch-docs/modules/ROOT/nav.adoc

+62

Diff for: spring-batch-docs/src/main/asciidoc/appendix.adoc renamed to spring-batch-docs/modules/ROOT/pages/appendix.adoc

+4-6

0 commit comments

Comments
 (0)