Make CI documentation accessible from the Pipeline Editor
Release notes
Problem to solve
Setting up a CI configuration requires reading lots of documentation. A developer who's writing a yaml CI config will need to frequently refer to the docs while writing and validating the YAML.
Currently, there's no way to easily navigate to the CI docs from within the CI area. One has to Google "GitLab CI docs" to get started.
Intended users
User experience goal
I want to easily set up a CI configuration without having to Google my way through setting up my first pipeline.
Proposal
Make the CI docs related to the yaml syntax and other major topics accessible from within the Pipeline Editor UI.
As an MVC, we can place a link/ button to the docs on the Pipeline Editor page so the docs are easy to find. The docs should open in a new tab.
https://docs.gitlab.com/ee/ci/yaml/README.html
Further details
The pipeline authoring team is working on the new dedicated Pipeline Editor for GitLab CI. Creating a dedicated space for authoring a CI configuration gives us an opportunity to create a truly helpful and welcoming 1st time CI experience even for novice users.