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

Replace IP addresses mentioned in the docs with a variable that includes an RFC 5737-compliant value #21778

Open
ptgott opened this issue Feb 13, 2023 · 1 comment
Labels
developer-experience Addressing these issues will improve the experience of developers working on Teleport documentation

Comments

@ptgott
Copy link
Contributor

ptgott commented Feb 13, 2023

Applies To

IP addresses mentioned throughout the docs

Details

See this comment for context: #21594 (comment)

Let's:

  • Add a variable to config.json that includes an IP address described in RFC 5737 (https://www.rfc-editor.org/rfc/rfc5737.html), or perhaps multiple variables for IP addresses if needed
  • Use this variable in the place of non-local IP addresses we mention in the docs

IPs provided for docs in RFC 5737:

The blocks 192.0.2.0/24 (TEST-NET-1), 198.51.100.0/24 (TEST-NET-2),
and 203.0.113.0/24 (TEST-NET-3) are provided for use in
documentation.

Related Issues

@ptgott
Copy link
Contributor Author

ptgott commented Apr 25, 2023

IP addresses with five or more occurrences:

% grep -RhEo "[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+" docs/pages | sort | uniq -c | sort -n | awk '$1 >= 5{print $0}'
   5 10.98.6.171
   5 172.31.0.196
   6 172.31.2.109
  10 1.2.3.4
  15 192.168.1.206
  57 0.0.0.0
  95 127.0.0.1

Distinct IP addresses:

% grep -RhEo "[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+" docs/pages | sort | uniq | wc -l
      86

@ptgott ptgott added the developer-experience Addressing these issues will improve the experience of developers working on Teleport label Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience Addressing these issues will improve the experience of developers working on Teleport documentation
Projects
None yet
Development

No branches or pull requests

1 participant