Skip to content

Limit use of image versioning to GitLab stuff

Mike Jang requested to merge mjang-doc-modify-versioning into master

What does this MR do?

Clarifies the current style guide direction w/r/t images outside of GitLab control.

GitLab docs currently include a number of images from outside companies. The practice is tolerated, as it helps our support organization diagnose customer issues.

Per our current guidance in https://docs.gitlab.com/ee/development/documentation/styleguide.html#images,

Screenshot_from_2020-04-02_14-43-35

We'd have to include the GitLab versioning format in the screenshots of non-GitLab software. This MR makes an exception for such screenshots.

Related issues

Author's checklist

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

  • Optional: 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.

Merge request reports

Loading