Skip to content

Update TW rake task with new info and groups

Amy Qualls requested to merge aqualls-update-tw-raketask into master

What does this MR do?

As part of Move the GitLab Pages docs to Editor group (!83321 - merged) I ran into some problems with the automated rake task output. Some pages were being removed, and I didn't understand why until I realized they belonged to two specific groups.

  • ~"group::authentication and authorization" was spelled with an & and thus the in-page metadata didn't have a match
  • grouprespond hadn't been added to the rake task yet
  • Further consideration: any other new groups we're missing?
  • Further consideration: we've hand-hacked the results to remove Marcia from some pages while she's out, and those hand-edited changes must be reapplied any time we generate a drop-in replacement list from the rake task. Could we instead do the reassignments (temporarily?) at the group level? It would be cleaner and faster.

Related issues

Author's checklist

If you are 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.

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

Merge request reports