Skip to content

Revise extension page title for accuracy

Amy Qualls requested to merge aqualls-revise-extension-page-title into master

What does this MR do?

In the 2021-11-03 Technical Writing team meeting, I was asked to revise the name of https://docs.gitlab.com/ee/user/project/repository/vscode.html (currently "GitLab Workflow VS Code extension") to "GitLab extension for VS Code". Based on https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#merge-request-reviews the extension's name is "GitLab Workflow," so I've proposed changing the name to "GitLab Workflow extension for VS Code". (cc @sselhorn)

Aside for @phikai / @viktomas - the second line in https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#merge-request-reviews is "GitLab VSCode integration" and we probably need to change to "GitLab extension for VS Code". Created gitlab-vscode-extension!371 (merged) for that change. I'll see if I can quickly figure out where this info is specified in the extension's repo, and raise a separate MR.

Related issues

Author's checklist

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

  • ~"type::feature"
  • ~"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 above reviews. 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