Skip to content

Revises PostgreSQL-version warning message

Amy Qualls requested to merge aqualls-polish-warning-message into master

What does this MR do?

The groupdatabase team was tagged to review Set PostgreSQL 13 as the minimum supported version (!120551 - merged), and I noticed we could improve the messages we're showing to users with too-low PostgreSQL versions. That required changing these files:

  • lib/gitlab/config_checker/external_database_checker.rb
  • lib/gitlab/database.rb
  • locale/gitlab.pot
  • spec/lib/gitlab/config_checker/external_database_checker_spec.rb

The end result:

  • Old: Database (name) is using PostgreSQL $version, but PostgreSQL %{pg_version_minimum} is required for this version of GitLab. Please upgrade your environment to a supported PostgreSQL version, see %{pg_requirements_url} for details.
  • New: Database (name) is using PostgreSQL $version, but this version of GitLab requires PostgreSQL $version. Please upgrade your environment to a supported PostgreSQL version. See $url for details.

(This MR is really UI text, but the documentation template is closest.)

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 Amy Qualls

Merge request reports

Loading