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

VPN documentation proofreading #1506

Merged
merged 8 commits into from
Jul 18, 2024
Merged

VPN documentation proofreading #1506

merged 8 commits into from
Jul 18, 2024

Conversation

whyrlpool
Copy link
Contributor

Change Summary

openconnect.rst: spelling errors corrected
dmvpn.rst: small spelling error corrected
ipsec.rst: updated justification, changes to phrasing
l2tp.rst: updated justification, changes to phrasing
sstp.rst: updated justification, changes to phrasing

Related Task(s)

N/A, documentation change.

Related PR(s)

Backport

Ideally back to at least 1.4, but likely applicable to 1.3 as well.

Checklist:

@whyrlpool whyrlpool requested a review from rebortg as a code owner July 12, 2024 10:29
the applications.
match the IPsec policy of a typical site-to-site setup and you would need to
add special configuration for it, or adjust the source address for your
applications' outgoing traffic. GRE/IPsec has no such problem and is completely
Copy link
Member

Choose a reason for hiding this comment

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

Missplaced '?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

applications are plural, and it’s a possessive apostrophe
I can reword it to make it simpler if you’d prefer.

Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't it be application's then instead?

Copy link
Member

Choose a reason for hiding this comment

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

The intended syntax here is possessive(plural('application')). In different words, "or adjust the source address for outgoing traffic of your applications". I might prefer the latter, but I have no objections against "applications' outgoing traffic".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Your wording here is clearer. I’ll update the wording to match, thanks!

rephrase for clarity and to avoid possessive plural apostrophe
@dmbaturin dmbaturin merged commit 873a461 into vyos:current Jul 18, 2024
2 checks passed
@dmbaturin
Copy link
Member

Thanks!

c-po pushed a commit that referenced this pull request Jul 18, 2024
* Fix typos in openconnect.rst

change Cerbort->Certbot
Update first line to reflect that openconnect was introduced in 1.3-rolling (T2036)

* typo in dmvpn.rst

* ipsec.rst justification, minor phrasing changes

* l2tp.rst justification and phrasing changes.

* sstp.rst phrasing, justification changes

* Update ipsec.rst

rephrase for clarity and to avoid possessive plural apostrophe

(cherry picked from commit 873a461)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants