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

chore: use reserved values for phone numbers and domains where possible #2650

Merged
merged 9 commits into from
Nov 9, 2023

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Nov 3, 2023

We should be using example domains instead of real URLs where possible.

@bsmth bsmth requested review from a team as code owners November 3, 2023 15:54
@bsmth bsmth requested review from estelle and pepelsbey and removed request for a team November 3, 2023 15:54
Copy link
Member

@pepelsbey pepelsbey left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

Using example.com, http://example.com/, @example.com for examples is generally a good idea, especially in the case of emails. That said, URLs that give contextual support (or provide entertainment without being promotional) shouldn’t be replaced.

Also, good catch on the phone number. TIL: "The North American Numbering Plan reserves 555-01 numbers for fictitious purposes. "

@bsmth
Copy link
Member Author

bsmth commented Nov 9, 2023

Using example.com, http://example.com/, @example.com for examples is generally a good idea, especially in the case of emails. That said, URLs that give contextual support (or provide entertainment without being promotional) shouldn’t be replaced.

Yeah I think this makes sense, I've reverted most of the wiki links, but I agree, with emails and telephone numbers, we should use reserved values.

I presume it's also important what the example is doing (fetch or others that are actually making requests should only use example.com, I guess.)

@bsmth bsmth changed the title chore: use example.com for URLs where possible chore: use example.com and reserved values for URLs/email/domains where possible Nov 9, 2023
@bsmth bsmth changed the title chore: use example.com and reserved values for URLs/email/domains where possible chore: use reserved values for phone numbers and domains where possible Nov 9, 2023
@bsmth
Copy link
Member Author

bsmth commented Nov 9, 2023

I'm going ahead to merge this one after incorporating the feedback! TY 👍🏻

@bsmth bsmth merged commit 6ecd366 into mdn:main Nov 9, 2023
5 checks passed
@bsmth bsmth deleted the wiki-example-urls branch November 9, 2023 16:32
@Jxck
Copy link

Jxck commented Jan 10, 2024

Using example.com, http://example.com/, @example.com for examples is generally a good idea, especially in the case of emails. That said, URLs that give contextual support (or provide entertainment without being promotional) shouldn’t be replaced.

If real traffic happens from document, testing, demo etc will suffer domain owners. This is especially true for sites like MDN, which are used by many users.
Example domains are standardized for this purpose in RFC6761.
MDN should respect it.

When you require some context, *.example can be used like wiki.example, movie.example etc.
I'll re-revert some changes above in separate PR.
If you require more discussion, https://github.com/orgs/mdn/discussions/450 is the best place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants