From 8e6200efebca8aeb12cde360a395a4dedc826e04 Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Sat, 18 Nov 2023 01:51:51 -0700 Subject: [PATCH] document how to use latest URL of UI bundle --- README.adoc | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index b40fc8f..d64faaf 100644 --- a/README.adoc +++ b/README.adoc @@ -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