From f3516fe2a50f34b513f877acd4bd87235c488c53 Mon Sep 17 00:00:00 2001
From: wass3rw3rk <49894298+wass3rw3rk@users.noreply.github.com>
Date: Mon, 30 Sep 2024 14:40:03 -0500
Subject: [PATCH] enhance(ui): custom docs url

add note about customizing VELA_DOCS_URL
---
 content/installation/ui/reference/_index.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/content/installation/ui/reference/_index.md b/content/installation/ui/reference/_index.md
index 14251b807..46e238ff9 100644
--- a/content/installation/ui/reference/_index.md
+++ b/content/installation/ui/reference/_index.md
@@ -44,6 +44,8 @@ The variable can be provided as a `string`.
 
 {{% alert title="Note:" color="primary" %}}
 This variable has a default value of `https://go-vela.github.io/docs/`.
+
+Please note that this variable is used in deep links throughout the UI. Customizing this value assumes the target location utilizes the same URL structure as the official docs at the default location.
 {{% /alert %}}
 
 ### VELA_FEEDBACK_URL
@@ -80,4 +82,4 @@ The variable can be provided as an `integer`.
 This variable has a default value of `30`.
 
 This variable should match [the `VELA_MAX_BUILD_LIMIT` variable](/docs/installation/server/reference/#vela_max_build_limit) provided to the server.
-{{% /alert %}}
\ No newline at end of file
+{{% /alert %}}