Update examples & explanations for input value functions
What does this MR do?
The current wording and examples of Specify functions to manipulate input values and Predefined interpolation functions > expand_vars
are misleading.
expand_vars
specifically exists for fields where variable expansion usually isn't possible, such as job and stage names. The current examples in both of these documentation sections use expand_vars
in the script
section, where it is unnecessary.
This MR:
- Updates the examples so that they demonstrate the use-case for
expand_vars
- Adds an explanation of when to use
expand_vars
, and when it is not needed.
These changes arose from this Zendesk ticket (internal) where a customer misunderstood how expand_vars
worked, thinking that it was required any time you use a variable as an input value:
I'm still not sure what the point of expand_vars is personally. I can't think of a situation where I wouldn't want that to be the default behavior. I think it would be far cleaner to have a function for NOT expanding variables.
Related issues
- How
expand_vars
works is discussed in this thread: #387632 (comment 1366617361)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.