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

polish(v2): url-subpath config validation warning #4977

Merged
merged 1 commit into from
Jun 15, 2021

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Jun 15, 2021

Motivation

Related to #4925 (comment)

We should make it clearer that user should not use a subpath in site URL config, and rather use the baseurl field:

// docusarus.config.js
module.exports = {
  url: '<domain>/docs' // => BAD: emit a warning
}

In practice, it is an excuse to introduce a validation warning system for the site config, as we'll likely want to enforce stricter config over time, and emitting warning is a good way to progressively deprecate some bad config usage without annoying too much the users

@slorber slorber added the pr: polish This PR adds a very minor behavior improvement that users will enjoy. label Jun 15, 2021
@slorber slorber requested a review from lex111 as a code owner June 15, 2021 15:02
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 15, 2021
@netlify
Copy link

netlify bot commented Jun 15, 2021

✔️ [V2]

🔨 Explore the source changes: cfd5dbf

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

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

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

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

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

@github-actions
Copy link

Size Change: 0 B

Total Size: 623 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 87.6 kB 0 B
website/build/assets/js/main.********.js 444 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 63.4 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 28.2 kB 0 B

compressed-size-action

@slorber slorber merged commit 9fe79ca into master Jun 15, 2021
@slorber slorber deleted the slorber/url-subpath-config-validation-warning branch August 17, 2021 18:01
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: 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.

2 participants