Skip to content

Container Registry: split registry database instructions into separate pages

What does this MR do?

Splits the Container Registry metadata database setup instructions into separate, focused pages to improve user experience and reduce configuration errors.

Key improvements:

  • Prevents mixed-method confusion: Users can no longer accidentally combine steps from different import methods (one-step vs three-step), which has been observed in support tickets
  • Clearer navigation: Each setup scenario now has its own dedicated page with focused instructions
  • Reduced cognitive load: Users follow a single, linear path instead of navigating through multiple sections in one large document

The main page now provides clear decision points and links to:

  • New installations guide
  • One-step import guide
  • Three-step import guide

This addresses real-world issues where users were reading the full document top-to-bottom and mixing incompatible configuration steps.

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 Hayley Swimelar

Merge request reports

Loading