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

Do not translate example.com when writing translations #15499

Open
reinhart1010 opened this issue Jan 11, 2025 · 0 comments
Open

Do not translate example.com when writing translations #15499

reinhart1010 opened this issue Jan 11, 2025 · 0 comments

Comments

@reinhart1010
Copy link
Collaborator

Hi, as I found myself while preparing #15497, there may be cases of the example web domain example.com (as in placeholders) being translated in other languages.

While this mistake seems tolerable at a glance, doing so may put a potential security risk where a specific translation of example.com could resolve to a real web domain with unknown or malicious intentions. The real example.com, however, is solely reserved for IANA for documentation purposes, so it would still be safe for use for our technical documentation, as close to its original purpose.

So I would suggest to refrain translating example.com at least by our style guide, technically putting the term in a similar treatment with our stdin/stdout policy. Note that this does not apply to other kinds of network/internet/URI-related placeholders such as {{host}}:{{port}}.

@reinhart1010 reinhart1010 changed the title Do not translate example.com when providing translations Do not translate example.com when writing translations Jan 11, 2025
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

No branches or pull requests

1 participant