fix(v2): do not create route for document that serve as docs home page #2861
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
lex111
added
pr: breaking change
|
Deploy preview for docusaurus-2 ready! Built with commit d59b767 |
|
cc @yangshun |
yangshun
approved these changes
Jun 3, 2020
This was referenced Jun 4, 2020
Closed
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
Resolve #2830.
When we set the docs home page, we have two duplicate pages, for example, in the case of https://v2.docusaurus.io/:
These two pages contain the same content (document of "introduction"), this is not good for SEO. I missed this important thing and therefore did not define the canonical URL for the
/docsURL. However, after discussing with one our user, we decided it was best not to create a separate route for document at all, which serves as docs home page.Yes, this is a BC, but I guess we can recommend in release notes that our user add a redirect using our official plugin to inform search engines about this change.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Snapshots and preview.
On preview https://deploy-preview-2861--docusaurus-2.netlify.app/docs/introduction URL will not work.
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)