Skip to content

Update BG migration docs for removed methods

Patrick Bair requested to merge 343055-update-docs-for-removed-methods into master

What does this MR do?

Remove documentation that references background migration helper methods we removed in !73306 (merged).

We now only have two migration helpers for enqueuing background migrations, the most commonly used queue_background_migration_jobs_by_range_at_intervals and migrate_in.

I also updated the migration example to be compatible with the use of the helpers we support and recommend now. We also renamed the model and table that were used in that example, so I fixed those to make it less confusing.

Related issues

Related to #343055 (closed)

Author's checklist

If you are 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.

Review 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 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.
    • 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.
  • Ensure a release milestone is set.
Edited by Patrick Bair

Merge request reports