Add development guidance for URLs in GitLab
What does this MR do and why?
Related to #560240 and #579401
We are inconsistent with our URLs in GitLab and it causes bugs, specifically with the relative_url_root setting and Geo.
In the future we will be introducing Organization scoped routes which will also have problems from our inconsistencies with URLs. Specifically any URLs constructed on the frontend may not work in Organizations.
This MR is the first step in trying to standardize how we use URLs in GitLab by adding developer docs.
Where will it live on the docs site?
I was thinking it would live in the Development processes section
It sounds like the process is to update https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/blob/main/data/en-us/navigation.yaml after this is merged to add it to the navigation.
Next steps
- Add ESLint rule to prevent hardcoding/constructing URLs on the frontend - gitlab-org/frontend/eslint-plugin!147
- Fix all violations of this rule
References
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.