Skip to content

Consolidate Remote Development MVC docs

Problem Statement

The existing documentation regarding workspace links and remote development in GitLab is confusing and lacks clarity in differentiating between "inside GitLab" and "outside of GitLab" environments. The terminology used to describe these environments creates ambiguity and makes it challenging for users to understand the recommended infrastructure setup. The term "inside GitLab" is used to refer to workspaces, but it is unclear whether these workspaces require users to bring their own infrastructure, such as a Kubernetes cluster. This ambiguity creates confusion about the required setup for utilizing workspaces effectively.

The term "outside of GitLab" is mentioned in relation to a remote host VM with a different purpose. It is unclear whether this approach is still endorsed and recommended by GitLab. The documentation provided at https://docs.gitlab.com/ee/user/project/remote_development/#create-a-development-environment adds to the confusion. It is unclear whether creating a development environment is necessary for remote development workspaces.

Exit Criteria

  • Clarify the distinction between "inside GitLab" and "outside of GitLab" environments, providing clear guidance on the infrastructure requirements for workspaces.
  • Determine and clearly communicate whether utilizing a remote host VM for development purposes is still endorsed by GitLab.
  • Review and revise the documentation at https://docs.gitlab.com/ee/user/project/remote_development/#create-a-development-environment to ensure it provides accurate and comprehensive information on remote development workspaces.
  • Consolidate Remote Development and Workspaces section in the docs navigation. (Context - !120422 (comment 1386367882))
Edited by Vishal Tak