Make readme easier to follow for both local and non-local installations
Make readme easier to follow for both local and non-local installations.
Currently it is not clear what parts apply to local installations, non-local, or both.
This readme is part of our official installation instructions for Workspaces feature - https://docs.gitlab.com/ee/user/workspace/configuration.html#prerequisites . Thus, this README needs to be very clear and simple to follow.
Example
- Step 5 mentions
Point the ${GITLAB_WORKSPACES_PROXY_DOMAIN} and ${GITLAB_WORKSPACES_WILDCARD_DOMAIN} to load balancer where your ingress controller is listening.
which can be ambigious and confusing. - Similarly, this step is not really required for local installations if you are using a
.localdev.me
domain. If not using such a domain for local installation, you would have to probably update your hosts file.
See also this comment: !52 (comment 1686961601)
Edited by Chad Woolley