8000 gh-93573: Replace wrong example domains in configparser doc by sblondon · Pull Request #93574 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-93573: Replace wrong example domains in configparser doc #93574

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
Merged
merged 3 commits into from
Feb 16, 2023
Merged

gh-93573: Replace wrong example domains in configparser doc #93574

merged 3 commits into from
Feb 16, 2023

Conversation

sblondon
Copy link
Contributor
@sblondon sblondon commented Jun 7, 2022 •
edited by bedevere-bot
Loading

This minor PR replaces bytebong.com to python.org in configparser example in order to use a domain the PSF controls.

topsecret.server.com is obviously an example and I don't think bitbucket.org is a risk currently so they are not modified.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jun 7, 2022
@arhadthedev
Copy link
Member

topsecret.server.com

Maybe, topsecret.example.com would be better?

@tiran
Copy link
Member
tiran commented Jun 7, 2022

Documentation should use reserved TLDs from https://datatracker.ietf.org/doc/html/rfc2606, e.g. topsecret.python.example.

@sblondon
Use explicitly invalid domain
5cd6012 
topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
@sblondon
Copy link
Contributor Author
sblondon commented Jun 7, 2022

I replaced topsecret.server.com by topsecret.server.example so the difference between topsecret.server.example and python.org assertions are more obvious.

I don't think news are needed.

AA-Turner
AA-Turner approved these changes Jun 7, 2022
View reviewed changes
Copy link
Member
@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

If we're changing to .example, it might also be worth changing the bitbucket.org ones? I know the domain is currently active, but extra safety doesn't hurt.

A

@sblondon
Copy link
Contributor Author
sblondon commented Jun 7, 2022

bitbucket.org domain is now replaced by forge.example.

AA-Turner
AA-Turner approved these changes Jun 7, 2022
View reviewed changes
Copy link
Member
@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Thanks!

A

@AA-Turner AA-Turner added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Jun 7, 2022
@sblondon sblondon mentioned this pull request Jun 7, 2022
Closed
@sblondon sblondon changed the title gh-93573: Replace bytebong.com by python.org gh-93573: Replace unused domains to invalid ones, and bytebong.com to python.org Jun 14, 2022
@merwok
Copy link
Member
merwok commented Jun 14, 2022

IMHO server.example is not as easily understood as a domain name as server.example.com

@sblondon
Copy link
Contributor Author

IMHO server.example is not as easily understood as a domain name as server.example.com

RFC2606 reserves also example.{com,net,org}.
@tiran what do you think about it?

@merwok merwok changed the title gh-93573: Replace unused domains to invalid ones, and bytebong.com to python.org gh-93573: Replace wrong example domains in configparser doc Jun 28, 2022
@sblondon
Copy link
Contributor Author

The bytebong.com domain is now available to everyone:

$ whois bytebong.com
No match for domain "BYTEBONG.COM".
>>> Last update of whois database: 2022-11-21T12:47:09Z <<<
...

Should I ping a core reviewer for the merge?

@JulienPalard JulienPalard merged commit 924a3bf into python:main Feb 16, 2023
@miss-islington
Copy link
Contributor

Thanks @sblondon for the PR, and @JulienPalard for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-101953 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 16, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 16, 2023
@sblondon @miss-islington
pythongh-93573: Replace wrong example domains in configparser doc (py…
d5598a7 
…thonGH-93574)

* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain

topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
(cherry picked from commit 924a3bf)

Co-authored-by: sblondon <stephane.blondon@gmail.com>
@bedevere-bot
Copy link

GH-101954 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 16, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 16, 2023
@sblondon @miss-islington
pythongh-93573: Replace wrong example domains in configparser doc (py…
795d80f 
…thonGH-93574)

* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain

topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
(cherry picked from commit 924a3bf)

Co-authored-by: sblondon <stephane.blondon@gmail.com>
miss-islington added a commit that referenced this pull request Feb 16, 2023
@miss-islington @sblondon
gh-93573: Replace wrong example domains in configparser doc (GH-93574)
4d74bb4 
* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain

topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
(cherry picked from commit 924a3bf)

Co-authored-by: sblondon <stephane.blondon@gmail.com>
miss-islington added a commit that referenced this pull request Feb 16, 2023
@miss-islington @sblondon
gh-93573: Replace wrong example domains in configparser doc (GH-93574)
aedf383 
* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain

topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
(cherry picked from commit 924a3bf)

Co-authored-by: sblondon <stephane.blondon@gmail.com>
@sblondon sblondon deleted the remove-bytebong.com branch February 16, 2023 15:46
sblondon added a commit to sblondon/cpython that referenced this pull request Feb 17, 2023
@sblondon
pythongh-93573: Replace wrong example domains in configparser doc (py…
58e73ef 
…thonGH-93574)

* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain

topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JulienPalard JulienPalard JulienPalard approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

@MYavuzYAGIS MYavuzYAGIS MYavuzYAGIS approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@sblondon @arhadthedev @tiran @merwok @miss-islington @bedevere-bot @JulienPalard @AA-Turner @MYavuzYAGIS
0