Skip to content

Docs: Clarify steps how to create a remote development workspace

Michael Friedrich requested to merge docs-workspace-create-steps-clarify into master

What does this MR do?

I followed the documentation for workspaces, and got confused after navigating into the project to create a .devfile.yaml file. Thought that Workspaces would hide in the projects menu, hidden behind a feature flag. Searched for some minutes. Apparently, the context for Your work in the main menu was missing.

This MR clarifies the steps, and breaks the creation into two steps that require a context switch:

  1. the preparation with the projects .devfile.yaml
  2. Switching context into a different UI to create the workspaces.

I also wanted to make sure that folks know which .devfile.yaml they should create and fill, and linked the example configuration anchor below. This is part of the 5 minute success learning curve (more to come in future MRs).

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