-
Notifications
You must be signed in to change notification settings - Fork 11
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
Add a Tips and Tricks page #140
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for nebula-docs-dn ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
f1fece2
to
fefead7
Compare
Some of this information might be useful to users, but I'm not sure when in a user's Nebula journey they will find the "Tips n Tricks" page, or what they are looking for to get there. How are you envisioning users will find and use this information? Personally, I would not merge this change.
This is true, but probably is a better note for the getting started guide.
I think this is also a fact useful only during setup. And, while true, I think it's also obvious from the fact that
True and maybe worth calling out during first time setup. That being said, most users won't use P256 at all, so I'm not sure it's even worth mentioning. (This is something you'd really only think about if you're trying to achieve FIPS compliance - I think we consciously don't document this too heavily as we don't want to make any guarantees or else I'd say it deserves its own page. It's something Slack is using in some environments.)
Depends on
This is also true but isn't really a tip or a trick - it's a technical detail. Maybe it makes more sense for a "High-Level Overview" style documentation page. The part about using the Noise protocol is already listed under "Technical Details" on the main docs page. We don't explicitly mention that it's not X.509, and I am "meh" on doing so especially without explaining why not. Also the cert format will likely change with IPv6 to be ASN.1-based instead of protobuf-based.
True, but perhaps better suited for a high level overview of Nebula. (e.g. part of this description - https://nebula.defined.net/docs/)
CGNAT does tend to be a decent choice for many users, but not all. For example, people who also use Tailscale may experience conflicts this way. I think an "Network Space Considerations" page would make more sense than this contextless tidbit. |
This incorporates a bunch of little bits of missing info suggested by a user of nebula, LMK if there's someplace obvious where these should go elsewhere