-
-
Notifications
You must be signed in to change notification settings - Fork 71
[docs] Add WireGuard topology tutorial #253
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
base: master
Are you sure you want to change the base?
Conversation
WalkthroughA new tutorial document, "WireGuard Topology", was added to the tutorials directory and included in the tutorials index toctree. The tutorial describes prerequisites and step-by-step UI instructions to create a WireGuard configuration template (including an example JSON for wg0), enable topology visualization, assign the template to devices, and verify the topology with wg show and the Network Topology dashboard. No code, exported/public declarations, or runtime control flow were changed. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Pre-merge checks✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
tutorials/index.rsttutorials/wireguard-topology.rst
🧰 Additional context used
🪛 GitHub Actions: OpenWISP Docs
tutorials/wireguard-topology.rst
[error] 1-1: ReStructuredText formatting check failed during PRODUCTION=1 ./run-qa-checks. File could be reformatted.
🔇 Additional comments (2)
tutorials/index.rst (1)
12-12: toctree entry correctly added.The tutorial reference is properly registered in the documentation navigation with consistent formatting.
tutorials/wireguard-topology.rst (1)
1-102: No critical RST formatting issues found; cross-references follow established patterns in the codebase.The RST syntax is valid with properly formatted title underlines, code blocks, and cross-reference directives. The cross-reference pattern (
:doc:/controller/user/wireguard``, etc.) is standard throughout this documentation, used identically intutorials/hotspot.rst, `tutorials/mesh.rst`, `tutorials/wifi-access-point.rst`, and other tutorials. These module-level paths are dynamically built as part of the multi-version documentation process defined in `build.py`, not local files.Likely an incorrect or invalid review comment.
|
Thanks for taking a look. This PR addresses issue #222 by adding a dedicated tutorial that explains how to create a WireGuard topology in OpenWISP. The changes are intentionally kept small and focused , it only adds the new tutorial page and registers it in the tutorials index. No existing documentation or behaviour was changed beyond that. |
This PR addresses issue #222 by adding a dedicated tutorial explaining how to create a WireGuard topology template in OpenWISP and visualize it using the Network Topology module.
Changes
tutorials/wireguard-topology.rsttutorials/index.rstNotes