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

fix(preset-classic): broken link in "unrecognized keys" error message #8029

Merged
merged 1 commit into from Aug 31, 2022

Conversation

mdubus
Copy link
Contributor

@mdubus mdubus commented Aug 31, 2022

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

By running docusaurus with unrecognized keys inside the preset classic configuration, an error is displayed with a link to the documentation:
Capture d’écran 2022-08-31 à 10 52 19

The provided link (https://docusaurus.io/docs/presets#docusauruspreset-classic) leads to a Page not Found on the documentation:

Capture d’écran 2022-08-31 à 11 02 15

As the preset page doesn't exist anymore, it would make sense to replace the previous link with this one: https://docusaurus.io/docs/using-plugins#docusauruspreset-classic

Test links

Deploy preview: https://deploy-preview-8029--docusaurus-2.netlify.app/

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Aug 31, 2022
@netlify
Copy link

netlify bot commented Aug 31, 2022

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 6ae9b1b
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/630f25d87a822c000876107a
😎 Deploy Preview https://deploy-preview-8029--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 64 🟢 98 🟢 100 🟢 100 🟠 80 Report
/docs/installation 🟠 78 🟢 100 🟢 100 🟢 100 🟢 90 Report

Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

Thanks 👍

@slorber slorber added to backport This PR is planned to be backported to a stable version of Docusaurus pr: bug fix This PR fixes a bug in a past release. labels Aug 31, 2022
@Josh-Cena Josh-Cena changed the title misc(preset-classic): fix broken link in unrecognized keys error fix(preset-classic): broken link in "unrecognized keys" error message Aug 31, 2022
@slorber slorber merged commit c4f808a into facebook:main Aug 31, 2022
@mdubus mdubus deleted the patch-1 branch August 31, 2022 15:02
@slorber slorber added backported This PR has been backported to a stable version of Docusaurus and removed to backport This PR is planned to be backported to a stable version of Docusaurus labels Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backported This PR has been backported to a stable version of Docusaurus CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants