Rob Winch 1d40740ce3 Fix deploy-docs.yml content sources (#461)
* Fix deploy-docs.yml content sources

Include future branches and tags, but exclude old tags and branches
that do not contain Antora builds

* Reduce GitHub permissions to read only
2023-09-25 17:57:38 -05:00
2023-09-25 13:27:08 -05:00
2023-09-25 13:24:56 -05:00
2023-09-25 13:24:56 -05:00

= Spring for Apache Pulsar Docs Build

You're currently viewing the Antora playbook branch.
The playbook branch hosts the docs build that is used to build and publish the production docs site.

The Spring for Apache Pulsar reference docs are built using https://antora.org[Antora].
This README covers how to build the docs in a software branch as well as how to build the production docs site locally.

== Building the Site

You can build the entire site by invoking the following and then viewing the site at `build/site/index.html`

[source,bash]
---- 
./gradlew antora
----

== Building a Specific Branch

You can build a specific branch and then viewing the branch specific site at `build/site/index.html`.

[source,bash]
----
./gradlew antora
----
Description
No description provided
Readme 4.3 MiB
Languages
Java 99.3%
Groovy 0.5%
Shell 0.1%