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.

Sign up for GitHub

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

Jump to bottom

fix(init): change initial site URL to one that is safe for the future #9133

Merged
merged 1 commit into from
Jul 13, 2023
Merged

fix(init): change initial site URL to one that is safe for the future #9133

merged 1 commit into from
Jul 13, 2023

Conversation

tats-u
Copy link
Contributor

@tats-u tats-u commented Jul 9, 2023 •
edited
Loading

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

The current initial template specifies https://your-docusaurus-test-site.com for the site URL. This is used for OGP contents. Everyone can reserve this domain and an organization (or person) related to casino in Turkey has already done.

https://www.virustotal.com/gui/url/e8aeabbb3b02e8c207176c74dbf41fbf807fbf4be6f45c7f6ff9a139417ec181/details
https://otx.alienvault.com/indicator/domain/your-docusaurus-test-site.com

RFC 2606 reserves the .example domain for illustrative purposes. (See the Section 2) We have to use this instead. (.test or example.{com,org,net}are also OK)

Test Plan

Test links

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

Related issues/PRs

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jul 9, 2023
@netlify
Copy link

netlify bot commented Jul 9, 2023 •
edited
Loading

✅ [V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit b4b1b7f
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/64aabed87b835d0007ddb796
😎 Deploy Preview https://deploy-preview-9133--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.

@github-actions
Copy link

github-actions bot commented Jul 9, 2023 •
edited
Loading

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 86 🟢 97 🟢 92 🟢 100 🟠 89 Report
/docs/installation 🟠 73 🟢 100 🟢 92 🟢 100 🟠 89 Report

Josh-Cena
Josh-Cena reviewed Jul 9, 2023
View reviewed changes
packages/create-docusaurus/templates/classic/docusaurus.config.js Outdated
@@ -14,7 +14,7 @@ const config = {
favicon: 'img/favicon.ico',

// Set the production url of your site here
url: 'https://your-docusaurus-test-site.com',
url: 'https://your-docusaurus-site.example',
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe use .example.com? Seems more unsurprising.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Josh-Cena Not so terrible, but it looks longer than .example.
A candidate is your-docusaurus-site.example.com or docusaurus-site.example.com.

https://example.com & https://www.example.com are resolved to an example page by IANA, but pages for the other subdomains don't seem to be prepared.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's okay if the page is a broken page. And yes, I meant your-docusaurus-site.example.com.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, I'll rename all of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Josh-Cena Done.

@tats-u tats-u requested a review from Josh-Cena July 9, 2023 13:59
Josh-Cena
Josh-Cena reviewed Jul 9, 2023
View reviewed changes
Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Almost good. Could you revert the changes in examples/? These are autogenerated. Also I think some fixtures have an extra trailing line break; I'm enabling the tests to see if they still pass.

@tats-u
Copy link
Contributor Author

tats-u commented Jul 9, 2023 •
edited
Loading

@Josh-Cena Are these 2 all, aren't they?
image

@tats-u
Change initial site URL to one that is safe for the future
b4b1b7f 
RFC 2606 reserves the `.example` domain for illustrative purposes.
@Josh-Cena
Copy link
Collaborator

Yes

@tats-u
Copy link
Contributor Author

tats-u commented Jul 9, 2023

@Josh-Cena Done

@tats-u
Copy link
Contributor Author

tats-u commented Jul 9, 2023

Why did the Build Performance CI task fail?

Josh-Cena
Josh-Cena approved these changes Jul 13, 2023
View reviewed changes
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.

Since the other tests are passing, this is fine. The build performance action is not very stable anyway.

@Josh-Cena Josh-Cena changed the title Change initial site URL to one that is safe for the future fix(init): change initial site URL to one that is safe for the future Jul 13, 2023
@Josh-Cena Josh-Cena added the pr: polish This PR adds a very minor behavior improvement that users will enjoy. label Jul 13, 2023
@Josh-Cena Josh-Cena merged commit 16a366b into facebook:main Jul 13, 2023
@tats-u tats-u deleted the fix-init-url branch July 13, 2023 13:59
@tats-u
Copy link
Contributor Author

tats-u commented Jul 13, 2023

Thanks. We can cherry-pick this in the v2 branch.

@Josh-Cena Josh-Cena added the to backport This PR is planned to be backported to a stable version of Docusaurus label Jul 13, 2023
@slorber
Copy link
Collaborator

slorber commented Jul 19, 2023

The current initial template specifies https://your-docusaurus-test-site.com/ for the site URL. This is used for OGP contents. Everyone can reserve this domain and an organization (or person) related to casino in Turkey has already done.

Damn, we live in a crazy world 😅 thanks for noticing this and fixing it

This was referenced Oct 19, 2023
Merged
Merged
@slorber slorber removed the to backport This PR is planned to be backported to a stable version of Docusaurus label Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Josh-Cena Josh-Cena Josh-Cena approved these changes

@slorber slorber Awaiting requested review from slorber slorber is a code owner

@lex111 lex111 Awaiting requested review from lex111

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA pr: polish This PR adds a very minor behavior improvement that users will enjoy.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tats-u @Josh-Cena @slorber @facebook-github-bot