correctly document how to disable the editUrl (and hence Edit this Page link)
authorDan Allen <dan@opendevise.com>
Wed, 11 Sep 2019 12:07:21 +0000 (06:07 -0600)
committerDan Allen <dan@opendevise.com>
Wed, 11 Sep 2019 12:10:36 +0000 (06:10 -0600)
docs/modules/ROOT/pages/templates.adoc

index 3ea263a..cac655e 100644 (file)
@@ -115,8 +115,12 @@ If there's only a single version of the component, the canonical URL is the qual
 
 | page.editUrl
 | The URL to edit the current page (typically a web-based editor on the git host).
-This value will not be set if the repository requires authentication or the repository URL embeds credentials.
-A quick way to disable this property (and thus the "Edit this Page" link) is to start the repository URL with `\https://git@`.
+
+| page.origin.private
+| This value will be true if the repository requires authentication or the repository URL embeds credentials.
+In the default UI, if this value is `true`, the "Edit this Page" link is disabled.
+A quick way to force this property to be `true` (even if the repository is public) is to begin the content source URL in the playbook with empty credentials, as in `\https://@`.
+That, in turn, disables the "Edit the Page" link.
 
 | page.home
 | Indicates whether the current page is the home page of the site.