Support splat (wildcard) redirects
In #24 (closed), a simple redirect mechanism was implemented https://docs.gitlab.com/ee/user/project/pages/redirects.html.
It would be great if we also supported splat (wildcard) redirect support. According to the Netlify docs:
/news/* /blog/:splat
This would redirect paths like /news/2004/01/10/my-story
to /blog/2004/01/10/my-story
.
It would mean a lot for the docs site, since we want to move away from the /ee
prefix and use something like /gitlab
.
/ee/* /gitlab/:splat
Release Notes
Details to be added
Designs
- Show closed items
Blocks
Relates to
- #62015.41
Activity
-
Newest first Oldest first
-
Show all activity Show comments only Show history only
- Achilleas Pipinellis changed milestone to %13.4
changed milestone to %13.4
- Achilleas Pipinellis removed workflowin review label
removed workflowin review label
- Achilleas Pipinellis removed milestone %13.4
removed milestone %13.4
- Jackie Porter added grouprelease [DEPRECATED] label and removed 1 deleted label
added grouprelease [DEPRECATED] label and removed 1 deleted label
- Achilleas Pipinellis changed title from Support splat redirects to Support splat (wildcard) redirects
changed title from Support splat redirects to Support splat (wildcard) redirects
- Achilleas Pipinellis changed the description
Compare with previous version changed the description
- Achilleas Pipinellis marked this issue as related to gitlab#292442 (moved)
marked this issue as related to gitlab#292442 (moved)
- Achilleas Pipinellis mentioned in issue gitlab#290680 (closed)
mentioned in issue gitlab#290680 (closed)
- Achilleas Pipinellis mentioned in merge request gitlab-docs!1391 (closed)
mentioned in merge request gitlab-docs!1391 (closed)
@axil do these ones need workflowplanning breakdown to be picked up? Adds it to: https://gitlab.com/gitlab-org/gitlab-docs/-/boards/1668857?
Collapse replies - Author Developer
@eread probably, but no idea. I've never used that label.
- Maintainer
Just a note that the Technical Writing team is using this functionality and would benefit from any improvements: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/content/_redirects.
- Evan Read added workflowplanning breakdown label
added workflowplanning breakdown label
- Achilleas Pipinellis mentioned in issue #537
mentioned in issue #537
- Achilleas Pipinellis added Technical Writing label
added Technical Writing label
- Nathan Friend mentioned in issue gitlab-org/ci-cd/release-group/release#62 (closed)
mentioned in issue gitlab-org/ci-cd/release-group/release#62 (closed)
- Nathan Friend mentioned in merge request !458 (merged)
mentioned in merge request !458 (merged)
@nfriend @jaime should I put this in %13.12 instead of #23 (closed)?
Collapse replies - Maintainer
@ogolowinski yes! I think this feature solves #23 (closed) in a nicer way and it's something that Technical Writing would be very happy about!
2
- Orit Golowinski mentioned in issue gitlab#326982 (closed)
mentioned in issue gitlab#326982 (closed)
- Maintainer
@nfriend already has a working PoC in !458 (merged) and the change is fairly "simple"; and we would need to update the redirect docs too. I think weight 2 is fine, unless we feel like we need to break down !458 (merged) further.
- Jaime Martinez set weight to 2
set weight to 2
- Orit Golowinski changed milestone to %13.12
changed milestone to %13.12
- Orit Golowinski mentioned in issue #23 (closed)
mentioned in issue #23 (closed)
- Contributor
Issue status: 25% complete, 60% confident
MR statuses:
- !458 (merged): In review. This is my first time writing Go and contributing to GitLab Pages, so I expect lots of back and forth during review.
- gitlab!59803 (merged): Not started. This is a documentation update MR.
1 Collapse replies - Developer
@nfriend I moved this to workflowin dev . Please update that if it is incorrect.
- Contributor
@nicolewilliams Sorry, I haven't been good about updating this issue. I think we can move this to workflowin review. I'll post another update below.
- Maintainer
@ogolowinski, please add an appropriate tier label from:
- Orit Golowinski added GitLab Core GitLab Premium GitLab Ultimate labels
added GitLab Core GitLab Premium GitLab Ultimate labels
- Nicole Williams added workflowin dev label and removed workflowplanning breakdown label
added workflowin dev label and removed workflowplanning breakdown label
- Nicole Williams added cicdactive label
added cicdactive label
- Contributor
Issue status: 75% complete, 50% confident
MR statuses:
-
!470 (merged): Merged
✅ - !458 (merged): In maintainer review.
- gitlab!59803 (merged): Not started. This is a documentation update MR.
Moving this issue to workflowin review
2 1 -
!470 (merged): Merged
Collapse replies - Developer
No problem @nfriend, thanks for the update!
- Nathan Friend added workflowin review label and removed workflowin dev label
added workflowin review label and removed workflowin dev label
- Nathan Friend mentioned in merge request gitlab!59803 (merged)
mentioned in merge request gitlab!59803 (merged)
- Jaime Martinez changed milestone to %14.0
changed milestone to %14.0
- Jaime Martinez removed [deprecated] Accepting merge requests label
removed [deprecated] Accepting merge requests label
- Jaime Martinez assigned to @nfriend
assigned to @nfriend
- Contributor
Issue status: 50% complete, 0% confident (that this will ship in %14.1)
😞 MR statuses:
-
!470 (merged): Merged
✅ - !458 (merged): In development.
- gitlab!59803 (merged): In development. This is a documentation update MR.
Based on some feedback during the maintainer review, !458 (merged) will need to undergo some pretty fundamental re-architecting to make the feature more maintainable long-term. I haven't found the time to dive back into this over the last few weeks, and unfortunately won't have time in the near future since I'll be OOO for most of July.
I will plan on picking this back up when I'm back in August, unless someone feels really inspired to finish this off while I'm out
😄 .So, in summary: sorry for the delay, but this is still on my radar!
-
!470 (merged): Merged
Collapse replies
- Contributor
Issue status: 30% complete, 0% confident that this will ship in time for %14.2, 50% confident that this will ship in time for %14.3
MR statuses:
-
!470 (merged): Merged
✅ - !458 (merged): In initial review.
- gitlab!59803 (merged): In review. This is a documentation update MR.
Now that I'm back from OOO, I took another look at !458 (merged) and implemented a first draft of the changes requested during code review. It's working, but I expect there will be a lot of discussion and further changes before it's merged.
These new changes expand the scope of the MR a bit - the MR now implements splats and generic placeholders. (I'll update the MR's description to reflect this shortly.)
Also note that my last day with GitLab is August 20
😢 . I'm going to try to get as far as I can with this MR before I leave, but I may need to hand it off if it's not done by the end of next week.Edited by Nathan Friend -
!470 (merged): Merged
Collapse replies
- Evan Read mentioned in issue gitlab-docs#1070 (closed)
mentioned in issue gitlab-docs#1070 (closed)
- Nathan Friend changed milestone to %14.3
changed milestone to %14.3
- Contributor
Issue status: 60% complete, 50% confident that this will ship in time for %14.3
MR statuses:
-
!470 (merged): Merged
✅ - !458 (merged): In second round of initial review.
- gitlab!59803 (merged): In review. This is a documentation update MR.
I spent some time rethinking the organization of the new code being introduced in !458 (merged) - I think it's in a better place now. I've submitted these new changes for another round of review with @jaime.
I also updated the documentation MR with some details I discovered while writing tests for this feature.
1 -
!470 (merged): Merged
- Contributor
Issue status: 80% complete, 70% confident that this will ship in time for %14.3
MR statuses:
-
!470 (merged): Merged
✅ - !458 (merged): In the final stages of review. I think it's really close!
- gitlab!59803 (merged): In review. This is a documentation update MR.
I think !458 (merged) is really close to being ready
🎉 . Since my last day with GitLab is tomorrow (Friday), I'll be handing it off to either @jaime or @vshushlin in case there are any final changes that need to be made.1 -
!470 (merged): Merged
Collapse replies - Maintainer
Thank you again!
❤ @jaime can you take over and enable/test this in our production?
1 - Maintainer
@vshushlin can do! We'll need to cut a new release though
😓 @jaime @vshushlin If you have plans to cut a release in the next week or two, it can probably wait if that's better for y'all.
🙇🏻 1 - Maintainer
Maybe we can at least wait for !552 (closed) before cutting the release.
1 1 - Maintainer
https://gitlab.com/gitlab-com/gl-infra/chef-repo/-/merge_requests/490 to enable on staging once we cut a release
1 - Maintainer
- Developer
@vshushlin @kbychu a release post item for 14.3
😄 2
- Contributor
Issue status: 90% complete, 75% confident that this will ship in time for %14.3
MR statuses:
-
!470 (merged): Merged
✅ -
!458 (merged): Merged
✅ - gitlab!59803 (merged): In review. This is a documentation update MR.
All code changes have been merged! All that's remaining is to enable and test this feature in production (and also get the documentation MR merged), and then this issue can be closed!
1 -
!470 (merged): Merged
Collapse replies - Developer
Awesome, thank you @nfriend!
1
- Jaime Martinez mentioned in merge request !552 (closed)
mentioned in merge request !552 (closed)
- Jaime Martinez assigned to @jaime
assigned to @jaime
- Jaime Martinez added workflowverification label and removed workflowin review label
added workflowverification label and removed workflowin review label
- Jaime Martinez mentioned in merge request !555 (merged)
mentioned in merge request !555 (merged)
- Kevin Chu changed the description
Compare with previous version changed the description
- Kevin Chu added release post itemsecondary label
added release post itemsecondary label
- 🤖 GitLab Bot 🤖 added release post itemin review label and removed release post itemsecondary label
added release post itemin review label and removed release post itemsecondary label
- 🤖 GitLab Bot 🤖 mentioned in merge request gitlab-com/www-gitlab-com!89137 (merged)
mentioned in merge request gitlab-com/www-gitlab-com!89137 (merged)
- Maintainer
gitlab!69213 (merged) has reached workflowproduction so I will start by enabling the feature on staging first https://gitlab.com/gitlab-com/gl-infra/chef-repo/-/merge_requests/490. It is a global setting so we can't target specific projects at the moment.
@eread would you or someone in Technical Writing like to do some testing once this hits staging?
Edited by Jaime Martinez1 Collapse replies Thanks for looking after that, @marcel.amirault
🙇🏻 1
- Maintainer
Tested this on staging with this project https://staging.gitlab.com/jaimem88/redirects-public/. I used some rules defined in the docs examples. And I've also recorded a demo on this. The same project on GitLab.com https://gitlab.com/jaime/redirects-public shows the same placeholder rules as invalid.
I made some notes while recording the demo and will update the docs MR soon.
I'll also push this to Pages in production soon.
Thank you so much @nfriend for this awesome feature
🎉 Edited by Jaime Martinez1 Collapse replies - Contributor
I cannot wait to try this out myself in production! Thanks so much @jaime for pushing this through!
🏅 1 - Maintainer
Demo available here https://youtu.be/FojVIiEAjSw
- Developer
- Jaime Martinez added workflowstaging label and removed workflowverification label
added workflowstaging label and removed workflowverification label
- Maintainer
I had a look at the profiler (internal) in Production for the redirects path and the performance impact seems low. It seems there is not enough data on staging for this so it probably has low impact. I'll enable the feature in production and keep an eye on those metrics, but they will only increase as more projects use this feature so it should be safe enough to keep the feature on.
Allocated heap
CPU Time
Collapse replies - Maintainer
@eread The latter! Staging has very low traffic and I bet not many projects have redirects enabled, and even less traffic.
So we could enable a redirect on https://docs.gitlab.com/gitlab and observe it.
- Maintainer
FTR here is the change request gitlab-com/gl-infra/production#5449 (closed), however there is an ongoing incident so it may not get enabled until that is resolved.
1 - Developer
@marcel.amirault an excellent interim step.
- Maintainer
@eread @marcel.amirault @axil this has made it to workflowproduction! Let me know when you start testing so I can keep an eye on the logs and metrics
🙇 - Developer
- Maintainer
Awesome! This is happening!
🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 🚀 Thanks, everyone!
❤ 7 5 5 - Author Developer
We verified it's working for the docs site! Example URL pointing to
/ce/
and redirects to/ee/
https://docs.gitlab.com/ce/administration/geo/replication/datatypes.html#limitations-on-replicationverification1 - Contributor
So excited about this!! Just put together a demo Pages site: https://nfriend.gitlab.io/pages-spa-demo/a/client/side/route
2
- Jaime Martinez mentioned in issue gitlab-com/gl-infra/production#5449 (closed)
mentioned in issue gitlab-com/gl-infra/production#5449 (closed)
- Jaime Martinez marked this issue as related to gitlab-com/gl-infra/production#5449 (closed)
marked this issue as related to gitlab-com/gl-infra/production#5449 (closed)
- Jaime Martinez added workflowproduction label and removed workflowstaging label
added workflowproduction label and removed workflowstaging label
- Marcel Amirault mentioned in merge request gitlab-docs!2094 (merged)
mentioned in merge request gitlab-docs!2094 (merged)
- Achilleas Pipinellis mentioned in issue technical-writing#363
mentioned in issue technical-writing#363
- Jaime Martinez marked this issue as related to #619 (closed)
marked this issue as related to #619 (closed)
- Jaime Martinez marked this issue as related to #620 (closed)
marked this issue as related to #620 (closed)
- Jaime Martinez marked this issue as related to #618 (closed)
marked this issue as related to #618 (closed)
- Jaime Martinez marked this issue as related to #24 (closed)
marked this issue as related to #24 (closed)
- Jaime Martinez marked this issue as related to #621
marked this issue as related to #621
- Maintainer
Hey all! I haven't seen anything crazy in production so far, at least not in the logs and the graphs. The only "concern" is the high memory allocation and CPU time that some rules may cause. Seems like Pages is not being affected by this but just something to keep an eye on.
I've also created a few follow-up issues and linked them above. I'll close this issue once the docs get merged
🎉 Collapse replies - Author Developer
@jaime docs are merged! Do we want to keep this open for the release post item though gitlab-com/www-gitlab-com!89137 (merged)?
1 - Maintainer
All merged, thank you all for your help and patience!
- Jaime Martinez closed
closed