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: Link initialization docs together #10740

Merged
merged 2 commits into from
Dec 5, 2024

Conversation

waldyrious
Copy link
Contributor

@waldyrious waldyrious commented Dec 4, 2024

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

I came across an older project that still referenced the docusaurus-init package, which has been converted into create-docusaurus in #5635. I had a hard time figuring this out because the current docs don't make any mention of this, and the npm page for the old package doesn't indicate that it's been replaced either.

So I added links from the current initial setup docs to the page describing create-docusaurus, as well as a redirect from 'docusaurus-init' to 'create-docusaurus', so that people can still find the current page even when searching for the old name.

Test Plan

Test links

Direct links to affected pages:

Related issues/PRs

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 4, 2024
Copy link

github-actions bot commented Dec 4, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 72 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🟠 55 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 74 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 63 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🔴 48 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 64 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 74 🟢 100 🟢 100 🟠 86 Report

Copy link

netlify bot commented Dec 4, 2024

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 900eea7
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/67508c2644154a00082bf20d
😎 Deploy Preview https://deploy-preview-10740--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 configuration.

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Dec 5, 2024
@slorber
Copy link
Collaborator

slorber commented Dec 5, 2024

thanks 👍

@slorber slorber merged commit 01cad20 into facebook:main Dec 5, 2024
18 checks passed
@waldyrious waldyrious deleted the link-init-docs branch December 5, 2024 17:57
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.

3 participants