Skip to content

Rename infrastructure registry to Terraform Module Registry in the docs

Marcel Amirault requested to merge docs-terraform-registry-rename into master

What does this MR do?

As per the related issues, the Infrastructure Registry and Terraform Module Registry features are essentially the same thing and being merged together in the docs:

  • The nav item is being renamed from Infrastructure Registry to Terraform module (the page title will be Terraform Module Registry).
  • There already exists documentation for the Terraform module registry, so we can move everything in the Infrastructure registry doc into the Terraform Module Registry doc.

The changes are split into two main commits:

  • First commit renames all "Infrastructure registry"/"package" language to "Terraform module registry"/"module" as needed.
  • Second commit merges them together into doc/user/packages/terraform_module_registry/index.md, leaving a redirect behind in doc/user/packages/infrastructure_registry/index.md
    • As part of this, I had to move some sections around to make them all work together.
    • I did not copy over the #use-gitlab-cicd-to-build-packages section from the Infrastructure registry page, as it was just a crossslink to the Terraform module registry page, repeating information that was already there.
  • (and an extra commit to add the version history, and fix the navigation language as we're not yet updating the new super sidebar language)

Review app: https://main-ee-116947.docs.gitlab-review.app/ee/user/packages/terraform_module_registry/index.html

Screenshots

Before After
Infrastructure Registry: Screenshot_2023-04-06_at_22.30.11
Terraform module registry: Screenshot_2023-04-06_at_22.30.03
Terraform module registry:
Screenshot_2023-04-06_at_22.33.39

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 Marcel Amirault

Merge request reports

Loading