UX: Improve documentation for workspace end users
MRs:
Description
There's room for improving our documentation to better address the needs of our end users. The workspaces documentation currently prioritizes an admin persona which resulted in avoidable mistakes during a recent UX Scorecard gitlab-design#2445 (closed)
Acceptance Criteria
TODO: Fill out (required)
-
Alignment on proposed solution
Proposed solution
- Link to a quick start guide for launching a workspace on the workspace parent page
- Revisit the create workspace instructions as these often pop up from a Google search:
- Have a quick start section at top of the page
- Revisit
Set up a workspace
heading as this is often first place users looks even though it's only relevant to admin persona. Consider creating separate pages for admin and developer personas. - The
Create a workspace
section directs users toYour work > Workspaces
. Would be helpful to also show the other ways to create/launch workspace (e.g. fromEdit
in project). - Revisit the workspaces intro paragraph. The description isn't resonating with people in helping them understand what it is and why they want to use the feature.
- Related: #412938 (closed)
- Link to a walkthrough tutorial video from the docs to help visual learners (todo: split into separate issue)
- Link to a workspaces feedback issue from the docs so we can iterate more effectively.
-
Created doc MR !169112 (merged) Feedback from @atanayno : "The doc Connect to a workspace with SSH says:
SSH must be enabled for the workspace
. What does it mean and how should it be enabled?"-
@cwoolley-gitlab I believe this means that the container for the workspace should have
sshd
properly configured, which is covered in the section below: https://docs.gitlab.com/ee/user/workspace/configuration.html#update-your-workspace-container-image - This should probably be made clearer in the docs.
-
@cwoolley-gitlab I believe this means that the container for the workspace should have
-
Created doc MR !169112 (merged) Feedback from @atanayno : It also says
You must have a TCP load balancer that points to the GitLab workspaces proxy.
This part is also not very clear. Is it about the ingress that we deploy earlier?- @cwoolley-gitlab This is just referring to this setup for your DNS: https://docs.gitlab.com/ee/user/workspace/set_up_workspaces_proxy.html#update-your-dns-records
- That should also be made clearer, and/or add a link.
Edited by Chad Woolley