Skip to content

Docs - style: clarify GL version for screenshots

Marcia Ramos requested to merge docs-gl-version-screenshots into master

What does this MR do?

Clarifies that the GL version added to file names should correspond to the GL version the screenshot was taken from.

The current guideline is a little confusing thus it may be misinterpreted.

For example, if a feature was introduced in 12.0, but taken from GL 12.5, the screenshot should be named example_v12_5.png. By doing so, for future reference, it's easier to identify outdated screenshots as they don't relate to the version the feature was introduced to GL, but the version it was taken from.

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.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading