docs: add a few redirects #4232
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erwanor
approved these changes
Apr 17, 2024
Follow-up to #4215, in which we reorganized the guide for readability. Some of the existing content got shuffled into subroutes, and already one person in Discord has pointed out that we broken URLs. Tacking on some http redirects via mdbook [0]. [0] https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect
|
This didn't work as well as I'd hoped: the mdbook settings are html-level redirects, so they display a warning in Firefox. Worse, the redirects conflict with the |
conorsch
added a commit
that referenced
this pull request
May 1, 2024
Modifies the firebase hosting config to remove the `/<version>/` prefix from the guide URLs, which has only ever been `/main/`, due to #6. Also includes rewrites so that historical URLs with the `/main/` prefix will still be honored, and redirected to the appropriate location that's live in the docs. Squirreling away this one-liner for generating a "sitemap" of all URLs: curl -s http://localhost:5000 \ | rg -i 'class="chapter"' \ | perl -npE 's/href=/\nhref=/g ' \ | perl -nE '/href="([\w.\/]+)"/g and say $1' > sitemap.txt which was helpful in creating the redirects. Removes the mdboook-only meta-refresh redirects added in #4232, because the browser UX was atrocious. Refs #3417.
1 task
hdevalence
pushed a commit
that referenced
this pull request
May 6, 2024
Modifies the firebase hosting config to remove the `/<version>/` prefix from the guide URLs, which has only ever been `/main/`, due to #6. Also includes rewrites so that historical URLs with the `/main/` prefix will still be honored, and redirected to the appropriate location that's live in the docs. Squirreling away this one-liner for generating a "sitemap" of all URLs: curl -s http://localhost:5000 \ | rg -i 'class="chapter"' \ | perl -npE 's/href=/\nhref=/g ' \ | perl -nE '/href="([\w.\/]+)"/g and say $1' > sitemap.txt which was helpful in creating the redirects. Removes the mdboook-only meta-refresh redirects added in #4232, because the browser UX was atrocious. Refs #3417.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Follow-up to #4215, in which we reorganized the guide for readability. Some of the existing content got shuffled into subroutes, and already one person in Discord has pointed out that we broken URLs. Tacking on some http redirects via mdbook [0].
[0] https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect
Issue ticket number and link
Checklist before requesting a review
If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: