Commit 8f0fce0e authored by Amy Qualls's avatar Amy Qualls

Merge branch 'dzaporozhets-master-patch-07384' into 'master'

Add guide to URL changing

See merge request gitlab-org/gitlab!63863
parents 8c28ec09 9a74ae79
...@@ -69,6 +69,18 @@ gitlab-org/gitlab/-/settings/repository ...@@ -69,6 +69,18 @@ gitlab-org/gitlab/-/settings/repository
gitlab-org/serverless/runtimes/-/settings/repository gitlab-org/serverless/runtimes/-/settings/repository
``` ```
## Changing existing routes
Don't change a URL to an existing page, unless it's necessary. If you must make a change,
make it unnoticeable for users, because we don't want them to receive `404 Not Found`
if we can avoid it. This table should help:
| URL description | Example | What to do |
|---|---|---|
| Can be used in scripts and automation | `snippet#raw` | Support both an old and new URL for one major release. Then, support a redirect from an old URL to a new URL for another major release. |
| Likely to be saved or shared | `issue#show` | Add a redirect from an old URL to a new URL until the next major release. |
| Limited use, unlikely to be shared | `admin#labels` | No extra steps required. |
## Migrating unscoped routes ## Migrating unscoped routes
Currently, the majority of routes are placed under the `/-/` scope. However, Currently, the majority of routes are placed under the `/-/` scope. However,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment