Update the Sidekiq worker removal instructions
🔬 What does this MR do?
In https://docs.gitlab.com/ee/development/sidekiq/compatibility_across_updates.html#in-the-first-minor-release, there are some instructions that are confusing. Step 4 states:
In a separate merge request, because it’s a migration, consider using the sidekiq_remove_jobs helper migration method in a post-deployment migration:
I don't see why it has to go in a different MR.
Actually, it is better if the sidekiq_remove_jobs
migration goes with MR 2 (https://docs.gitlab.com/ee/development/sidekiq/compatibility_across_updates.html#in-a-subsequent-separate-minor-release).
Why?
- The first MR still have the worker class (but it's a no-op). We could still miss code that enqueues the jobs (step 1). This means that even if we have the migration there, we could still have code that enqueues the job.
- On the second MR, we remove the class itself. This will catch any leftover code that enqueues the job (because we need the class to enqueue the job). The CI pipeline will certainly be
❌ if we try to read a class that doesn't exist anymore. Once this MR is deployed, it's a good idea to run thesidekiq_remove_jobs
migration.
⛓ Related issues
None
🏁 Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: - [-] If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added.
-
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.