Skip to content

Refactor the consolidated object storage section

What does this MR do?

Continue refactoring the object storage docs to follow the CTRT guidelines.

Notably:

  • Move paragraphs around so that make more sense and be more fluid.
  • Rename "Consolidated object storage configuration" section to "Configure a single storage connection for all object types"
  • Rename "Common parameters" section to "Configure the common parameters"
  • Rename "Object-specific configuration" to "Configure the parameters of each object". This was bugging me for a while. We also have "Storage-specific configuration" which is about configuring each object type separately with different credentials. I almost always never knew which one referred to what.
  • Rename "Storage-specific configuration" to "Configure each object type to define its own storage connection"

Main file to review: !116660 (diffs). The others are fixes to anchor links.

Review app: https://main-ee-116660.docs.gitlab-review.app/ee/administration/object_storage.html

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.

Merge request reports

Loading