Skip to content

Add a legend of possible pipeline statuses and their icons

Brie Carranza requested to merge bcarranza-pipeline-status-legend-docs into master

What does this MR do?

This MR adds a legend of possible pipeline statuses and the corresponding icons to the docs about pipelines. This was motivated by a conversation in a ticket 🎫 that is available to GitLab team members with access to ZenDesk. Being able to refer to a table like this would have aided the resolution of the ticket and would be generally useful.

Example

This is an example of the table.

Pipeline Status Icon Alt Text
pending pending yellow "pause" sign
running running circle two-thirds filled with blue
passed success green checkmark in green circle
failed failed red x in red circle
skipped skipped
canceled canceled dark gray slash (top left to bottom right) in dark gray circle

Questions for Technical Writing Team

  • YES. Is copying the referenced CI favicons from app/assets/images/ci_favicons into doc/ci/img the best way to get the referenced images in the docs? (It seems like a reasonable approach but requires duplicating the images with in the code base and that seems suboptimal but not completely unreasonable.)

Screenshots (strongly suggested)

A screenshot of how this looks in the review app:

Screen_Shot_2021-06-28_at_12.58.47_PM

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

documentation Support Team Contributions customer

Edited by Brie Carranza

Merge request reports