WireGuard: Confusing roadwarrior instructions - Githubissues

opnsense / docs

OPNsense documentation

Other

113 stars 179 forks source link

WireGuard: Confusing roadwarrior instructions #549

Closed HritwikSinghal closed 3 months ago

HritwikSinghal commented 3 months ago

[x] I have read the contributing guide lines at https://github.com/opnsense/docs/blob/master/CONTRIBUTING.md
[x] I have searched the existing issues and I am convinced that mine is new.

Describe the issue

on https://docs.opnsense.org/manual/how-tos/wireguard-client.html , it seems few steps have not been updated after this commit https://github.com/opnsense/docs/commit/ac586586b2ebc9a81d40a352a7f7d4ad76c89587 .

This commit Removed the 1st step and all the steps after that were changed in number. (so "step 2" became "step 1" and so-on). But at a few places, the changes were not made. see below.

these Hints suggests steps in 5a, before "step 5" (or "5a"). This is because "Step 5a" was renamed To "step 4a", but not in the hinds

Step 7 does not exist, change to step 6.

Repeat step 2, not 3

steps shoud be 4a and 4b, not 5a and 5b.

should be 4a

And many more!

Suggestions

Will open a PR to fix this. Edit: https://github.com/opnsense/docs/pull/550

Version affected

latest Docs Master as of Apr 5 2024

HritwikSinghal commented 3 months ago

this PR should fix these issues. Please review this thoroughly.

https://github.com/opnsense/docs/pull/550

AdSchellevis commented 3 months ago

@HritwikSinghal thanks for offering the PR, we seem to have missed the renumbering in the text.

HritwikSinghal commented 3 months ago

Hey, I can still see the Website with old version, out-of-date numbering.

fichtner commented 3 months ago

Maybe you have more luck on Sunday? 😉

HritwikSinghal commented 3 months ago

Maybe you have more luck on Sunday? 😉

ah, there must be some release pipeline to push changes to website. i assumed the changes would propagate as soon as the code was updated on github.

fichtner commented 3 months ago

It‘s updated in batches. For now I think there won’t be any updates on the weekend that seem pressing.

Cheers, Franco

HritwikSinghal commented 3 months ago

It‘s updated in batches. For now I think there won’t be any updates on the weekend that seem pressing.

Cheers, Franco

makes sense. thanks for clearing that up :)

AdSchellevis commented 3 months ago

pushed (https://docs.opnsense.org/manual/how-tos/wireguard-client.html)