Skip to content

Docs addition: Adding an example badge for pipeline status

Derek requested to merge ScriptAutomate/gitlab:example-badge-doc into master

What does this MR do?

Adds some example steps for adding a GitLab CI pipeline status badge to a project repository.

Related issues

This helps add an example, as requested from #235012 (closed)

There should be more examples on this page than the one I am adding, so I don't think this MR should close out that issue.

Part of Write the Docs Portland 2020 technical-writing#217 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Cynthia "Arty" Ng

Merge request reports