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

refactor: remove deprecated docs homePageId option #6065

Merged
merged 2 commits into from
Dec 7, 2021

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented Dec 7, 2021

Breaking changes

The homePageId has been marked as deprecated for a long time. Users using homePageId should consider setting slug: / in the front matter of their doc file instead.

Motivation

The homePageId has been declared deprecated for over a year now, it's probably time to remove it.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Preview/tests

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

@lex111 lex111 added pr: breaking change Existing sites may not build successfully in the new version. Description contains more details. pr: polish This PR adds a very minor behavior improvement that users will enjoy. labels Dec 7, 2021
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 7, 2021
@netlify
Copy link

netlify bot commented Dec 7, 2021

✔️ [V2]

🔨 Explore the source changes: 2f19533

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61af73f6e7eaf50007afe5b6

😎 Browse the preview: https://deploy-preview-6065--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Dec 7, 2021

⚡️ Lighthouse report for the changes in this PR:

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

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

@Josh-Cena
Copy link
Collaborator

I've thought about it, but docusaurus-migrate is only able to migrate v1 docs with the homePageId option as opposed to slugs—is it good to let the migration CLI ship a broken site by default?

@github-actions
Copy link

github-actions bot commented Dec 7, 2021

Size Change: 0 B

Total Size: 656 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 40.1 kB
website/build/assets/css/styles.********.css 101 kB
website/build/assets/js/main.********.js 485 kB
website/build/index.html 29.5 kB

compressed-size-action

@lex111
Copy link
Contributor Author

lex111 commented Dec 7, 2021

Just fixed it, users will need to set the root doc item manually.

@Josh-Cena Josh-Cena added the status: awaiting review This PR is ready for review, will be merged after maintainers' approval label Dec 7, 2021
@slorber
Copy link
Collaborator

slorber commented Dec 7, 2021

LGTM thanks 👍

@slorber slorber merged commit f96a051 into main Dec 7, 2021
@slorber slorber deleted the lex111/homepageid-remove branch December 7, 2021 18:48
@Josh-Cena Josh-Cena removed the status: awaiting review This PR is ready for review, will be merged after maintainers' approval label Dec 8, 2021
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: breaking change Existing sites may not build successfully in the new version. Description contains more details. pr: polish This PR adds a very minor behavior improvement that users will enjoy.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants