Skip to content

Commit 8e6200e

Browse files
committed
document how to use latest URL of UI bundle
1 parent e188873 commit 8e6200e

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,24 @@ The rest of the material for the docs site comes from the content repositories.
4646

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

49-
[source,yaml,subs=attributes+]
49+
[,yaml,subs=attributes+]
5050
----
5151
ui:
5252
bundle:
5353
url: {url-project}/releases/download/{current-release}/ui-bundle.zip
5454
----
5555

56+
To avoid having to manage the release number in the URL, you can grab the latest release using the following configuration instead:
57+
58+
[,yaml,subs=attributes+]
59+
----
60+
ui:
61+
bundle:
62+
url: {url-project}/releases/download/prod-latest/ui-bundle.zip
63+
----
64+
65+
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.
66+
5667
Read on to learn how to develop the UI.
5768

5869
== Development Quickstart

0 commit comments

Comments
 (0)