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

Update IPv6 Support page to remove explanation of what an IPv6 address is from introduction #370

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mivsvit
Copy link

@mivsvit mivsvit commented Dec 20, 2023

The characters s and t are not valid hex.
Correct the example 5001:0dt8:83a3:1012:1000:8s2e:0870:7454 so that it is a valid IPv6 address.
Also change to use the 2001:db8::/32 IPv6 documentation prefix.


📚 Documentation preview 📚: https://cloudstack-documentation--370.org.readthedocs.build/en/370/

@DaanHoogland
Copy link
Contributor

@mivsvit do you think we need to add a warning not to use the example (ever)?

@mivsvit
Copy link
Author

mivsvit commented Jan 17, 2024

@mivsvit do you think we need to add a warning not to use the example (ever)?

I think better to remove most of that paragraph and just say as an introduction "CloudStack supports IPv6 for shared and isolated networks. It also supports IPv6 for VPC tiers." and leave it at that.

Given the technical level of the content on that page I would suggest it is fair to assume the reader should know already what an IPv6 address is. There are already examples of IPv6 CIDRs as appropriate later on that page.

And other parts of that introduction are not great - for example, although IPv6 has been slow to be adopted, it's been around for decades, it is not "recent" and it is not a good definition of IP that it "defines routing the network traffic".

@DaanHoogland
Copy link
Contributor

sounds good, would you extend your PR for this, @mivsvit ?

Remove some of the introduction which contained an explanation of what an IPv6 address is.
@mivsvit mivsvit changed the title Correct example IPv6 address and use documentation prefix Update IPv6 Support page to remove explanation of what an IPv6 address is from introduction Jan 17, 2024
@DaanHoogland
Copy link
Contributor

@alexandremattioli would you agree?

Co-authored-by: dahn <daan.hoogland@gmail.com>
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.

2 participants