docs: update link to init template README.md #6134
Conversation
|
Hi @cmpadden! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
|
✔️ [V2] 🔨 Explore the source changes: 1119e40 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61bfcb4f76e7e40007610251 😎 Browse the preview: https://deploy-preview-6134--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-6134--docusaurus-2.netlify.app/ |
There was a problem hiding this comment.
Sorry, our fault of not updating the link. However, we do have a default README here: https://github.com/facebook/docusaurus/blob/main/packages/create-docusaurus/templates/shared/README.md
Please change the link target instead, sign the CLA, and we can merge
Signed-off-by: Colton Padden <[email protected]>
cmpadden
force-pushed
the
docusaurus-readme-404
branch
from
fd1508c
to
1119e40
Compare
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Updated. Thank you! |
Josh-Cena
changed the title
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Josh-Cena
added
the
pr: documentation
|
Thanks! |
Motivation
The v2 migration documentation links to a README that does not exist:
https://docusaurus.io/docs/migration/manual#readme
In this section, this link throws a 404:
https://github.com/facebook/docusaurus/blob/main/packages/create-docusaurus/templates/classic/README.md
This PR introduces a README.md file at the desired location, referencing the other READMEs found in the
packages/create-docusaurus/templates/directory.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Testing cannot take place until the README is merged into the main branch and the blob exists.
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.)