From 55c5e96a42b8354d42f06b545685590fce17ef81 Mon Sep 17 00:00:00 2001 From: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Date: Tue, 18 Jul 2023 08:40:37 +0100 Subject: [PATCH] Update product.yml code comments for guidance on specific variable usage (#39137) Co-authored-by: Laura Coursen --- data/variables/product.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/data/variables/product.yml b/data/variables/product.yml index 846094c0f04a..123ec6c62c07 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -3,12 +3,13 @@ # Company +# Use this variable when referring to the company in the context of its business. For example, in licensing agreements company_short: 'GitHub' # GitHub's flagship products product_name: >- {% ifversion ghec %}GitHub Enterprise Cloud{% elsif ghes %}GitHub Enterprise Server{% elsif ghae %}GitHub AE{% else %}GitHub{% endif %} -## Use this variable when the output should always be GitHub, regardless of the product the user is using +## Use this variable when referring to the product, when the output should always be GitHub. For example, "the GitHub REST API" prodname_dotcom: 'GitHub' ## Use this variable when the output should always be GitHub Enterprise, regardless of the product the user is using