breaking(v2): editUrl should point to website instead of docsDir #1958
Conversation
…upport editUrl in versioning/trans
endiliey
added
the
pr: breaking change
|
Deploy preview for docusaurus-2 ready! Built with commit 3945290 |
|
Deploy preview for docusaurus-preview ready! Built with commit 3945290 |
There was a problem hiding this comment.
It supports versioned_docs and translated_docs editUrl better in future
Good foresight. My only concern is that many users won't read the release notes and their docs edit button points to a broken URL after upgrading. I wonder if there's a way to help warn them about it, possibly just by searching for website/docs in the editUrl. This is also helpful for users porting from v1, not just v2 alpha dogfooders.
|
I'm also not sure on the best approach. For now I've tried to minimize the damage by editing the docs on migration. |
endiliey
added
the
status: don't merge yet
|
Don't merge since it includes docs change. Will only merge right before release new alpha |
Motivation
In v1,
editUrlis pointing todocsDirand its always pointing tonextfor the edit.Try https://docusaurus.io/docs/en/1.13.0/installation, notice the edit is for
nextdocs only.This breaking changes makes people moving docs folder around easier.
For example, if I renamed docs folder from
docstodocument. Before this PR i have to change the docs plugin path options fromdocstodocumentAND I HAVE to update myeditUrlfrom https://github.com/facebook/docusaurus/edit/master/website/docs/ to https://github.com/facebook/docusaurus/edit/master/website/document/ as well. Double work.After this PR, I only need to do it once
It supports versioned_docs and translated_docs editUrl better in future
Since we can always resolve it based from website dir. Since we already have lot of aliasing through
@site, it makes more sense to point it towebsiteinstead ofdocsDir.Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
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.)