From: Dan Allen <dan@opendevise.com>
Date: Fri, 14 Jan 2022 01:55:53 +0000 (-0700)
Subject: document the site.homeUrl property in the UI model; clarify how it differs from site... 
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=c4855c05aa2cf1679bd033e400306cff312bc14d;p=eg-antora.git

document the site.homeUrl property in the UI model; clarify how it differs from site.url and siteRootPath
---

diff --git a/docs/modules/ROOT/pages/templates.adoc b/docs/modules/ROOT/pages/templates.adoc
index 8868d7e..9b5e9df 100644
--- a/docs/modules/ROOT/pages/templates.adoc
+++ b/docs/modules/ROOT/pages/templates.adoc
@@ -36,6 +36,7 @@ s| [[site]]site
 
 | site.url
 | The base URL of the site, if specified in the playbook.
+If a site start page is defined, the visitor will be redirected from this location to the start page.
 
 | site.path
 | The pathname (i.e., subpath) of the site.url under which the site is hosted (e.g., /docs).
@@ -47,6 +48,9 @@ Can be prepended to `page.url` to create a root-relative URL for a page (e.g., `
 | site.title
 | The title of the site.
 
+| site.homeUrl
+| The URL that points directly to the start (aka home) page of the site.
+
 | site.components
 | A map of all the components in the site, keyed by component name.
 Properties of each component include name, title, url, latest, and versions.
@@ -177,6 +181,7 @@ s| env
 
 s| siteRootPath
 | The relative path to the root of the published site.
+If a site start page is defined, the visitor will be redirected from this location to the start page.
 
 s| uiRootPath
 | The relative path to the root directory of the UI.