Skip to content

Add section for interpreting schema_inconsistencies_metric

John Gaughan requested to merge jgaughan-master-patch-31fb into master

What does this MR do?

The schema_inconsistencies_metric output is equivalent to the database schema checker Rake task. @alexives has made it clear that customers should not take these schema inconsistencies at face value, or even try to use them for troubleshooting without the guidance of Support.

A customer recently opened a ticket expressing concern about this output from the Service Ping: https://gitlab.zendesk.com/agent/tickets/590684 (internal).

This MR is intended to clarify that customers should not be worried about schema inconsistencies reported from the Service Ping, and that the metric is only designed for GitLab team members to troubleshoot ongoing issues.

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.
Edited by John Gaughan

Merge request reports

Loading