docs(v2): GH pages: recommend using trailingSlash #5033
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
|
✔️ [V2] 🔨 Explore the source changes: 950dbb7 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/60d1a89b74196a0007b12056 😎 Browse the preview: https://deploy-preview-5033--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5033--docusaurus-2.netlify.app/ |
slorber
added
the
pr: documentation
|
Size Change: 0 B Total Size: 569 kB ℹ️ View Unchanged
|
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.
Motivation
Using the legacy
trailingSlash: undefinedbehavior is not recommended with GH pages due to the reconfigurable behavior of GH pages to add a trailing slash with a server redirect. This is better to use set explicit value (either true or false) instead of using the legacy retrocompatible behavior.Also adding a warning to the deploy script.
Note: later we may remove this because we could use
trailingSlash: falseas a default (after explicitly deprecating "undefined" legacy behavior). (but it might be a problem for deploying on Vercel without the cleanUrl option: see slorber/trailing-slash-guide#1)