Document environment variable used for Remote Development

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

• Close this issue

MR: Pending

Description

Context - !140458 (comment 1707570053)

• Create tables of all Remote Dev ENV vars we use, similar to https://docs.gitlab.com/ee/administration/environment_variables.html
• The table for the user-facing GITLAB_* vars can live in user-facing docs, somewhere under https://docs.gitlab.com/ee/user/workspace/
• The table for internal GL_* vars can live in developer-facing docs
  • For now, this can be in https://gitlab.com/gitlab-org/remote-development/gitlab-remote-development-docs/-/blob/main/README.md somewhere.
  • Going forward, I think we should create our own section for Remote Development under https://docs.gitlab.com/ee/development/feature_development.html#gitlab-components-and-features. This can initially just point to https://gitlab.com/gitlab-org/remote-development/gitlab-remote-development-docs/-/blob/main/README.md, but we can eventually start migrating parts of that which make sense into the main docs repo.

See also Allow images to be specified by ENV variables (!134984 - closed), which involves refactoring and standardizing our handling of GITLAB_* ENV vars.

Acceptance Criteria

TODO: Fill out (required)

• [Describe what must be achieved to complete this issue.]
• [Describe another requirement needed to complete this issue.]
• [Add additional acceptance criteria as needed.]

Technical Requirements

TODO: Fill out or delete [If applicable, please list out any technical requirements for this feature/enhancement.]

Design Requirements

TODO: Fill out or delete [If applicable, please provide a link to the design specifications for this feature/enhancement.]

Impact Assessment

TODO: Fill out or delete [Please describe the impact this feature/enhancement will have on the user experience and/or the product as a whole.]

User Story

TODO: Fill out or delete [Provide a user story to illustrate the use case for this feature/enhancement. Include examples to help communicate the intended functionality.]