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

WIP: Start of documentation #119

Open
wants to merge 1 commit into
base: master
from

Conversation

@JonTheNiceGuy
Copy link

JonTheNiceGuy commented Dec 20, 2019

Please can someone review what I've done thus far and see if it's useful? If so, I'll carry on, on this PR!

@rawdigits

This comment has been minimized.

Copy link
Member

rawdigits commented Dec 20, 2019

This seems like a great start! I think we need things like this to expand on the basic + limited example from the main README.md. As you add to it, we will go over it in technical detail just to be another set of eyes, but I like that you are covering some of the non-obvious features like DNS here.

@JonTheNiceGuy JonTheNiceGuy force-pushed the JonTheNiceGuy:master branch 5 times, most recently from bf2f89a to 68c9dbf Dec 23, 2019
@JonTheNiceGuy

This comment has been minimized.

Copy link
Author

JonTheNiceGuy commented Dec 23, 2019

OK, so I've added more content to this file, and it's ready for a tech vet. There are so TODO items, which are outside my scope of knowledge.

I've also added two simple-config-{lighthouse|node}.yml files for a "simple" setup that match what I imagine most people are likely to do with nebula. If you want those two dropping out into a separate PR, I'm more than happy to do so!

@JonTheNiceGuy JonTheNiceGuy force-pushed the JonTheNiceGuy:master branch 4 times, most recently from 4d0cf40 to fab34f9 Dec 23, 2019
@rawdigits

This comment has been minimized.

Copy link
Member

rawdigits commented Dec 29, 2019

Just wanted to let you know I gave this a read through. Thanks much for doing some forensic engineering to discover the features we haven't documented yet.

In the coming week, I'll give feedback on a couple of details that may be slightly incorrect in the doc, but overall this makes for a great start.

(I'll also nag someone else on the core team to review this!) :)

@JonTheNiceGuy JonTheNiceGuy force-pushed the JonTheNiceGuy:master branch from fab34f9 to 1fa3498 Dec 30, 2019
@JonTheNiceGuy

This comment has been minimized.

Copy link
Author

JonTheNiceGuy commented Dec 30, 2019

So, I've added some updates to this based on how my tickets I've raised have been responded to. If someone with more technical knowledge can cover off some of the TODO items, or at least comment on them here, I can update them accordingly...

@JonTheNiceGuy JonTheNiceGuy force-pushed the JonTheNiceGuy:master branch from 1fa3498 to 902a647 Jan 2, 2020
@JonTheNiceGuy

This comment has been minimized.

Copy link
Author

JonTheNiceGuy commented Jan 2, 2020

Updated based on info from #142 on subnets.

@JonTheNiceGuy JonTheNiceGuy force-pushed the JonTheNiceGuy:master branch from 902a647 to 7379e2e Jan 2, 2020
@JonTheNiceGuy

This comment has been minimized.

Copy link
Author

JonTheNiceGuy commented Jan 2, 2020

Added more detail from 142.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.