Frontend: Add docs links to the keyword tooltips in the pipeline editor
The Pipeline editor is our one-stop-shop for GitLab CI. In order to improve the authoring experience for new and novice users we would like to support them as they write or update their CI pipeline.
Release notes
Problem
GitLab CI could be intimidating to technical and non-technical users. In order to work with GitLab CI users need to be familiar with YAML which is error-prone. In addition, GitLab CI is highly flexible but with this flexibility comes a level of complexity, there are many keywords and ways to implement Pipelines, and it's difficult to understand and remember the properties of different keywords.
The auto-complete functionality by itself is not enough, users would need to understand what each keyword is doing and should be able to quickly navigate into the relevant docs section.
Intended users
User stories
When writing a pipeline configuration and using different templates and examples I want to easily learn what different keywords do and how to use them.
Proposal
Add docs links to all keywords in the CI Schema so they show up in the on-hover tooltips in the pipeline editor.
![]() |
![]() |
The "Learn more" link should open the appropriate section in the keyword reference documentation.
🔗 Figma design specs
Metrics
Permissions and Security
Accessible to all users who have access to the pipeline editor.
Documentation
Availability & Testing
Available Tier
- Free