Clarify status of not developed CI keywords in docs
Insight
In the CI pipeline keywords reference page, not all keywords have the same status. Some of them, like only
and except
, are not actively developed, and we discourage their use in favor of other preferred keywords.
However, that “not actively developed” status may not be immediately clear, given the content density of the page and the content of those keywords is as lengthy and displayed like any other keyword.
Action
Explore how to more clearly communicate the status of CI pipeline keywords. Some ideas to emphasize the keyword status over their content:
- Flag keyword status with a badge next to the keyword name.
- Collapse the content and just keep the keyword name and status visible by default.
- Move the content to 1+ pages/sections just for “unavailable” keywords (like “deprecated” or “not actively developed” keywords).
Resources
Tasks
-
Assign this issue to the appropriate Product Manager, Product Designer, or UX Researcher. -
Add the appropriate Group
(such as~"group::source code"
) label to the issue. This helps identify and track actionable insights at the group level. -
Link this issue back to the original research issue in the GitLab UX Research project and the Dovetail project. -
Adjust confidentiality of this issue if applicable