Migrate to Antora Documentation

* Use `providers.provider` for `modifiedFiles`.
This defers the looking up of `modifiedFiles` until it is used. It
also allows other tasks to be ran from the non-primary work tree.
Working in another work tree is essential for Antora which will clone
each branch/tag into a new work tree to process it.

* Migrate Structure

* Insert explicit ids for headers

* Fix image::image

* Copy default antora files

* Fix indentation for all pages

* Split files

* Generate a default navigation

* Remove includes

* Fix cross references

* Enable Section Summary TOC for small pages

* Polish nav.adoc

* Fix duplicate ids

* Escape {firstname} and {lastname}

* Remove links to htmlsingle and pdf Formats

* Fix broken links

* Disable attributes for ${debezium-version}

* Migrate to Asciidoctor Tabs

* Move to src/reference/antora

* Remove Asciidoctor Build

* deploy-docs only spring-projects
This commit is contained in:
Rob Winch
2023-08-10 14:10:47 -05:00
committed by GitHub
parent f9dc75c739
commit eb6ddfe429
319 changed files with 21512 additions and 22487 deletions

View File

@@ -58,7 +58,7 @@ Please see our [Security policy](https://github.com/spring-projects/spring-integ
# Documentation
The Spring Integration maintains reference documentation ([published](https://docs.spring.io/spring-integration/docs/current/reference/html/) and [source](src/reference/asciidoc)), GitHub [wiki pages](https://github.com/spring-projects/spring-integration/wiki), and an [API reference](https://docs.spring.io/spring-integration/docs/current/api/).
The Spring Integration maintains reference documentation ([published](https://docs.spring.io/spring-integration/reference/) and [source](src/reference/antora)), GitHub [wiki pages](https://github.com/spring-projects/spring-integration/wiki), and an [API reference](https://docs.spring.io/spring-integration/docs/current/api/).
There are also [guides and tutorials](https://spring.io/guides) across Spring projects.
@@ -90,9 +90,9 @@ To build api Javadoc (results will be in `build/api`):
./gradlew api
To build the reference documentation (results will be in `build/docs/asciidoc` and `build/docs/asciidocPdf`):
To build the reference documentation (results will be in `build/site`):
./gradlew reference
./gradlew antora
To build complete distribution including `-dist`, `-docs`, and `-schema` zip files (results will be in `build/distributions`):