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

Use IP addresses from documentation ranges cf. rfc5737 #28135

Merged
merged 2 commits into from
Jul 24, 2023

Conversation

SphinxKnight
Copy link
Member

@SphinxKnight SphinxKnight commented Jul 23, 2023

When doing some updates in the French section, I noticed that some IP addresses in the docs were not from reserved ranges.

Description

I changed existing IP addresses to reserved IP addresses for documentation

Motivation

https://datatracker.ietf.org/doc/html/rfc5737

Additional details

I may have been too "strict" for some articles and also have voluntarily left some mentions of non-reserved IP addresses when I felt they deserved to be kept in the documentation due to their nature (ex. ping mozilla.org…)

Reviewers may use the following regexp (\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3}) to look for IPv4 addresses. I used [0-9a-f]{1,4}:[0-9a-f]{1,4}:[0-9a-f]{1,4}:[0-9a-f]{1,4}:[0-9a-f]{1,4}:[0-9a-f]{1,4}:[0-9a-f]{1,4}:[0-9a-f]{1,4} for IPv6 but the existing occurrences wee fine.

https://en.wikipedia.org/wiki/Reserved_IP_addresses may be friendlier than the RFC if needed

@SphinxKnight SphinxKnight requested review from a team as code owners July 23, 2023 20:06
@SphinxKnight SphinxKnight requested review from jpmedley, sideshowbarker and teoli2003 and removed request for a team July 23, 2023 20:06
@github-actions github-actions bot added Content:WebExt WebExtensions docs Content:WebAPI Web API docs Content:Learn Learning area docs Content:HTTP HTTP docs Content:Glossary Glossary entries labels Jul 23, 2023
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

I have one (editorial) comment about using IPV4 instead of IPV6 for an example for readability, but everything else looks good, ty. Leaving a +1 here 👍🏻

@sideshowbarker sideshowbarker merged commit 8dfa0ec into mdn:main Jul 24, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Glossary Glossary entries Content:HTTP HTTP docs Content:Learn Learning area docs Content:WebAPI Web API docs Content:WebExt WebExtensions docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants