Skip to content

Suggestions page: fix logic holes and update images

Amy Qualls requested to merge aqualls-suggestions-old-imgs into master

What does this MR do?

As part of handling other work, I peeked in the spreadsheet companion to https://gitlab.com/gitlab-org/technical-writing/-/issues/842+ to see if any pages from groupcode review appeared on both the Outdated / Needs review spreadsheet, and the top 15% spreadsheet.

Sure enough, doc/user/project/merge_requests/reviews/suggestions.md appeared in both places. I'll take the 2-for-1 win, please and thank you.

In this merge request:

  • replace an ancient image
  • fill in some logic holes
  • leave TODO placeholders for prerequisites, so I can ask for a technical review from someone in groupcode review
  • redo a particularly fiddly part of the page that uses text to show how a suggestion is formatted

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.

Merge request reports