Skip to content

Move large instances information link to top

Evan Read requested to merge eread/move-large-instances-information-link-to-top into master

What does this MR do?

Thinking about: technical-writing#856, and in the context of technical-writing#843 (closed), some upgrade notes will be relevant to all versions of GitLab in a give major release and aren't really ever fixed because they're intentional.

This MR adds some text at the top of the "GitLab 16 change page":

  • To say that all minor versions should be consulted for relevant information.
  • To attempt to find a way to avoid duplication for upgrade notes that will affect all versions of GitLab 16 and that all upgraders should read.

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