Skip to content

Clarify migration types in migration style guide

Matthias Käppler requested to merge 335371-choose-migration-type-docs into master

What does this MR do?

This was on my own request, since I thought our current migration style guidelines for developers did not give sufficient guidance around when to choose:

  • Regular migrations
  • Post-deploy migrations
  • Background migrations

which should be the 1st step before creating one. So I added a new section in front of "creating a migration" to highlight the differences.

I also moved the migration timing guidelines from the database reviewer guide to the migration style guide, since the former is not read by developers, only database reviewers, and it is necessary to understand timing guidelines to choose the correct migration type.

Preview

The changes are deployed here: http://main-ee-66609.178.62.207.141.nip.io/ee/development/migration_style_guide.html

Related issues

Closes #335371 (closed)

Author's checklist

To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database

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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Matthias Käppler

Merge request reports