Skip to content

Commit

Permalink
document how to use latest URL of UI bundle
Browse files Browse the repository at this point in the history
  • Loading branch information
mojavelinux committed Nov 18, 2023
1 parent e188873 commit 8e6200e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,24 @@ The rest of the material for the docs site comes from the content repositories.

To use this UI with Antora, add the following configuration to the playbook file for your site:

[source,yaml,subs=attributes+]
[,yaml,subs=attributes+]
----
ui:
bundle:
url: {url-project}/releases/download/{current-release}/ui-bundle.zip
----

To avoid having to manage the release number in the URL, you can grab the latest release using the following configuration instead:

[,yaml,subs=attributes+]
----
ui:
bundle:
url: {url-project}/releases/download/prod-latest/ui-bundle.zip
----

In order for Antora to fetch the latest UI bundle in this case, the `--fetch` option must be used and the `snapshot` key must be set to `true` to bypass the cache.

Read on to learn how to develop the UI.

== Development Quickstart
Expand Down

0 comments on commit 8e6200e

Please sign in to comment.