Skip to content

Revamp pipeline view docs sections

Marcel Amirault requested to merge docs-pipeline-views into master

What does this MR do?

Our docs on pipeline views had out of date information and screenshots. On top of that, we also updated all the UI recently and we are now really out of date. This MR:

  • Removes all the old screenshots and adds new ones for the most important UI elements.
  • Copy edits a lot of the view-related content, and some low-hanging-fruit fixes in other areas of the page while I was at it.
  • Gives us a better "View pipelines" section to link to from other pages/release post items, and updates links as needed.
  • Reorganizes the view-related content into a new separate section, as it's independent from the "Create pipelines" content.

Review app link: https://main-ee-148389.docs.gitlab-review.app/ee/ci/pipelines/#view-pipelines

I've also added notes about the changes right into the diff where it's easier to see.

Related issues

Author's checklist

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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.
Edited by Marcel Amirault

Merge request reports