Skip to content

Add caveat about changes hitting SaaS earlier

Manuel Grabowski requested to merge mg-mention-saas-rollout-effects-20230426 into master

What does this MR do?

This adds a sentence to the deprecations page to explain that changes hit SaaS before the official release date.

Due to how we rollout features/changes to GitLab.com, SaaS users could be hit by changes before the date they could reasonably expect them to based on how we present information on the deprecation page. I'm happy to be corrected, but as far as I could tell we currently don't mention this anywhere. If we do, it might be hidden too well, and I think a sentence directly on the deprecations page would make sense.

Here's one example from the past: #361615 (comment 940039377)

The linked comment has this quote from a release blog post:

These changes will go live on GitLab.com sometime between April 23 – May 22, through our daily deployments, leading up to the official release announcement of 15.0 on May 22.

I took the wording here as inspiration for what I'm suggesting in this MR. It should definitely still be called out in the release blog posts as well, of course, but I think we can do a bit better by also adding another spot where users can see it. We'll never reach everyone, but the more people we do reach, the less frustration.

This MR is very much in the spirit of "Everything starts with an MR". I juggled many a word before being somewhat okay with it, but I fully expect a much much better way to put this to come up in review. And maybe this is not a good spot to put it, hopefully we'll find a better one then.

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