Skip to content

Add guidance for VS Code / Web IDE terms

Amy Qualls requested to merge aqualls-propose-vscode-guidance into master

What does this MR do?

Based on @brendan777's comments in !169195 (comment 2158840886), it's time to get some official guidance for VS Code / Web IDE terms into our style guide. (The Web IDE is based on VS Code, btw.) I'm currently migrating the VS Code extension's docs into the gitlab monolith as part of #493994.

Brendan's question was about the phrase command palette. The VS Code documentation (https://code.visualstudio.com/docs/getstarted/userinterface) uses title case to refer to UI elements.

  • Do we want to do that as well?
  • Do we want to bold these names? (I bolded them in this MR to nudge the conversation forward, but I think in the end we probably won't bold them.)

@ashrafkhamis will be interested in the outcome here, because he works on docs for the Web IDE.

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