Commit 3acbf71f authored by Dan Allen's avatar Dan Allen
Browse files

document the FORCE_SHOW_EDIT_PAGE_LINK environment variable

parent 5b68c242
......@@ -129,8 +129,12 @@ If there are multiple versions of the component, the canonical URL is the qualif
If there's only a single version of the component, the canonical URL is the qualified URL of the current page.
| page.editUrl
| The URL to edit the current page (typically a web-based editor on the git host).
The only hosts supported right now are github.com, gitlab.com, pagure.io, and bitbucket.org.
| The URL to edit the current page (i.e., activates the web-based editor on the git host).
This value is derived automatically for the hosts github.com, gitlab.com, pagure.io, and bitbucket.org, even if the repository is private.
If the host is not recognized, or you want to customize the value, you can use the `edit_url` key on the content source in the playbook.
The default UI shows an "Edit this Page" link that points to this URL unless the repository is private (i.e., `page.origin.private` is true).
You can force the link to be shown by setting the environment variable `FORCE_SHOW_EDIT_PAGE_LINK` or by customizing the UI template.
| page.origin.private
| This value will be true if the repository requires authentication or the repository URL embeds credentials.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment