Skip to content

Update page metadata to Distribution

Craig Norris requested to merge docs-install-metadata-update into master

What does this MR do?

This MR updates several pages in the documentation /install directory to update their stage from "Alliances" to "Enablement". The Enablement group is associated with the other pages in this directory, and we use the stage/group assignments to help people connect with a Technical Writer, if needed. Since there is no Alliances group on the page, we need to continue to point readers to groups that are discoverable on the TW Team page. The MR also removes the type parameter from the pages' metadata, now that it's no longer in use.

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports