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.

Sign up for GitHub

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

Jump to bottom

docs: add docs for gluon-mesh-vpn-wireguard #2351

Merged
merged 2 commits into from
Jun 9, 2022
Merged

docs: add docs for gluon-mesh-vpn-wireguard #2351

merged 2 commits into from
Jun 9, 2022

Conversation

lemoer
Copy link
Member

@lemoer lemoer commented Dec 28, 2021

No description provided.

@neocturne
Copy link
Member

Thanks, did you see #2349 and the doc changes in #2186? #2186 rewrites most of vpn.rst, so this PR will probably need to be rebased onto that...

@lemoer
Copy link
Member Author

lemoer commented Dec 28, 2021

No, I didn't. I'll rebase.

@lemoer
Copy link
Member Author

lemoer commented Dec 28, 2021

@NeoRaider Thanks. Updated.

@lemoer
Copy link
Member Author

lemoer commented Dec 29, 2021

I pushed another commit explaining the MTU selection for tunneldigger and wireguard.

@lemoer lemoer mentioned this pull request Dec 29, 2021
Merged
@neocturne neocturne added the 2. status: blocked Marked as blocked because it's waiting on something label Jan 1, 2022
@AiyionPrime
Copy link
Member

This eventually closes #2320.

@neocturne
Copy link
Member

#2186 has been merged, so this needs a rebase now.

@neocturne neocturne added 2. status: merge conflict The merge has a conflict and needs rebasing 2. status: waiting-on-author Waiting on some action from the author and removed 2. status: blocked Marked as blocked because it's waiting on something labels Feb 23, 2022
@lemoer
Copy link
Member Author

lemoer commented Feb 26, 2022

@NeoRaider Thanks, updated.

AiyionPrime
AiyionPrime requested changes Feb 26, 2022
View reviewed changes
Copy link
Member

@AiyionPrime AiyionPrime left a comment

Choose a reason for hiding this comment

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

I'm fine with the text as it is and appreciate the documentation of the MTU calculation, as well as the section about explicitly setting MSS.

It's a bit slangly, like the section around "glued together" technologies, but reads well otherwise.

I'd like you to take a look at the capitalization of abbreviations like VLAN or VXLAN and whether you think it would disturb the reading flow.

The other suggestions are mainly WireGuard as name,
mesh VPN without the dash,
DS-Lite with dash like in rfc 6333,
and minor spellfixes.

Last nitpick from me: could batman-adv be referenced as such instead of batman?

Otherwise this already is a great documentation, I'd say.

docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/user/faq.rst Outdated Show resolved Hide resolved
docs/user/faq.rst Outdated Show resolved Hide resolved
docs/user/faq.rst Outdated Show resolved Hide resolved
docs/user/faq.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
@lemoer
Copy link
Member Author

lemoer commented Feb 28, 2022

Thanks for the comments. Updated.

AiyionPrime
AiyionPrime approved these changes Feb 28, 2022
View reviewed changes
Copy link
Member

@AiyionPrime AiyionPrime left a comment

Choose a reason for hiding this comment

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

Looks nice, thanks.

@neocturne
Copy link
Member

Please squash the spelling fix commits into the commits they fix.

@lemoer lemoer force-pushed the pr_docs_wireguard branch from 9825278 to b6dad53 Compare March 17, 2022 21:39
@lemoer
Copy link
Member Author

lemoer commented Mar 17, 2022

@NeoRaider updated.

@lemoer lemoer force-pushed the pr_docs_wireguard branch from b6dad53 to 3e8dc30 Compare March 17, 2022 22:01
AiyionPrime
AiyionPrime approved these changes Mar 17, 2022
View reviewed changes
Copy link
Member

@AiyionPrime AiyionPrime left a comment

Choose a reason for hiding this comment

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

This looks good. Both content and squash wise.

neocturne
neocturne previously requested changes Mar 20, 2022
View reviewed changes
Copy link
Member

@neocturne neocturne left a comment

Choose a reason for hiding this comment

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

I finally found the time to give this a more thorough look. My apologies for not doing this before asking you to squash your commits.

docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/user/faq.rst Outdated Show resolved Hide resolved
docs/user/faq.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/user/site.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
docs/features/vpn.rst Outdated Show resolved Hide resolved
@lemoer lemoer force-pushed the pr_docs_wireguard branch from eddc3d6 to ae00e13 Compare May 22, 2022 01:04
@lemoer lemoer requested a review from neocturne May 22, 2022 01:23
@lemoer lemoer assigned lemoer and unassigned lemoer May 22, 2022
@lemoer
Copy link
Member Author

lemoer commented May 22, 2022 •
edited
Loading

@NeoRaider Everything you requested has been taken into account.

@lemoer
Copy link
Member Author

lemoer commented May 22, 2022 •
edited
Loading

I just need to figure out how to cross-reference another page in rst/sphinx. I wasn't able yet...

@lemoer lemoer force-pushed the pr_docs_wireguard branch from 1b9d309 to b2f75e5 Compare May 22, 2022 15:12
@lemoer
Copy link
Member Author

lemoer commented May 22, 2022 •
edited
Loading

Works now. Please merge.

@neocturne
Copy link
Member

There's a new merge conflict due to the merge of #2352.

@lemoer lemoer force-pushed the pr_docs_wireguard branch from b2f75e5 to 707f819 Compare June 7, 2022 16:31
@lemoer
Copy link
Member Author

lemoer commented Jun 7, 2022

@NeoRaider Thanks for the hint. Rebased.

@blocktrron blocktrron dismissed neocturne’s stale review June 9, 2022 19:38

Approved without explcitly using GitHub tools

@blocktrron blocktrron merged commit fa02188 into freifunk-gluon:master Jun 9, 2022
@AiyionPrime AiyionPrime mentioned this pull request Jun 14, 2022
Closed
@lemoer lemoer deleted the pr_docs_wireguard branch February 17, 2023 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AiyionPrime AiyionPrime AiyionPrime approved these changes

@neocturne neocturne Awaiting requested review from neocturne

Assignees
No one assigned
Labels
2. status: merge conflict The merge has a conflict and needs rebasing 2. status: waiting-on-author Waiting on some action from the author 3. topic: docs Topic: Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@lemoer @neocturne @AiyionPrime @blocktrron