Extend documentation about db:check-migrations
What does this MR do and why?
I feel like it's not clear in our docs what the db:check-migration
does, why it does, and where it does.
I've also seen some MRs where the job fails the schema comparison just because the MR is behind the target branch.
So, my proposal is to extend this documentation to hopefully bring clarity to developers as well as provide a doc reference for reviewers when explaining what's behind this job.
This is a follow-up from an MR where this happened (!78560 (comment 815328950)):
I also noticed that the db:check-migrations job failed, but it looks unrelated. Is this normal or do I need to do something?
🤔
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 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. -
Ensure a release milestone is set.
Edited by João Alexandre Cunha