Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update link to init template README.md #6134

Merged
merged 1 commit into from Dec 20, 2021

Conversation

cmpadden
Copy link
Contributor

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.)

@facebook-github-bot
Copy link
Contributor

Hi @cmpadden!

Thank you for your pull request and welcome to our community.

Action Required

In 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.

Process

In 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 CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@netlify
Copy link

netlify bot commented Dec 20, 2021

✔️ [V2]
Built without sensitive environment variables

🔨 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

@github-actions
Copy link

github-actions bot commented Dec 20, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 79
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-6134--docusaurus-2.netlify.app/

Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 <colton.padden@fastmail.com>
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 20, 2021
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@cmpadden
Copy link
Contributor Author

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

Updated. Thank you!

@Josh-Cena Josh-Cena changed the title Add README.md to Classic Docusaurus Template to Resolve 404 docs: update link to init template README.md Dec 20, 2021
@facebook-github-bot
Copy link
Contributor

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 Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Dec 20, 2021
@Josh-Cena
Copy link
Collaborator

Thanks!

@Josh-Cena Josh-Cena merged commit 638a171 into facebook:main Dec 20, 2021
@cmpadden cmpadden deleted the docusaurus-readme-404 branch December 20, 2021 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants