Clarify MASQUE requirement across Cloudflare Mesh docs - #32691
Open
nikitacano wants to merge 1 commit into
Open
Conversation
Hostname routes, IPv6 CIDR routes, and high availability all require the MASQUE protocol and do not work if a Mesh node or client device has been switched to WireGuard. This was previously only documented as a buried bullet in the high-availability Considerations section. - Add a new 'Protocol requirement' section to the Mesh overview page stating this plainly, with links to each affected capability. - Add a shared partials/cloudflare-one/mesh/masque-required.mdx note, reused in the Hostname routes, high-availability, and containers (Kubernetes HA + hostname routing) sections. - Add explicit MASQUE call-outs to the Hostname routes prerequisites and the IPv6 CIDR routes description in routes.mdx. - Add a brief pointer in get-started.mdx and client-devices.mdx. Avoids calling this a 'tunnel protocol' anywhere in Mesh docs (clashes with the separate Cloudflare Tunnel product name), and does not frame WireGuard as a supported alternative for Mesh -- only ever mentioned as a limitation (what breaks if a device has been switched to it).
Contributor
Review💡 4 suggestions found in commit 👉 Fix in your agent 👈Fix the following review findings in PR #32691 (https://github.com/cloudflare/cloudflare-docs/pull/32691).
Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order
After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.
The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.
---
## Code Review
### Suggestions (2)
#### CR-8b6220222eb0 · Duplicate MASQUE requirement message
- **File:** `src/content/docs/cloudflare-one/networks/connectors/cloudflare-mesh/high-availability.mdx` line 222
- **Issue:** Line 20 already renders the `mesh/masque-required` partial, which states that this feature requires MASQUE and does not work with WireGuard. Line 222 then repeats the same requirement inline under Setup requirements.
- **Fix:** Rely on the rendered partial for the MASQUE/WireGuard warning so the requirement lives in one reusable place and cannot drift out of sync with the same page.
#### CR-886e51c6b2d0 · Misplaced indented paragraph in list
- **File:** `src/content/docs/cloudflare-one/networks/connectors/cloudflare-mesh/get-started.mdx` line 36
- **Issue:** The MASQUE requirement paragraph is indented with a tab, which attaches it to the preceding `(Optional) A Linux server to deploy a Mesh node` list item. The requirement applies to all Mesh nodes and client devices, not only optional Linux servers, so readers may misread it as conditional on installing a server node.
- **Fix:** Move the paragraph out of the list indentation (remove the leading tab) so it stands as a top-level note under Prerequisites, or place it inside its own `:::note` block if desired.
---
## Style Guide Review
### Suggestions (2)
#### SG-7a805d70e9f1 · Avoid passive voice
- **File:** `src/content/partials/cloudflare-one/mesh/masque-required.mdx` line 6
- **Issue:** Line uses passive voice: "if the node or device has been switched to WireGuard"
- **Fix:** Rewrite in active voice, e.g., "It does not work if the node or device uses WireGuard."
#### SG-089ce6f87fbe · Passive voice
- **File:** `src/content/docs/cloudflare-one/networks/connectors/cloudflare-mesh/get-started.mdx` line 36
- **Issue:** Line contains `has been switched to WireGuard`
- **Fix:** Rewrite in active voice, e.g., `if you have switched a node or device to WireGuard`.
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. Suggestions (2)
ConventionsNo convention issues found. Style Guide ReviewSuggestions (2)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Hostname routes, IPv6 CIDR routes, and high availability all require the MASQUE protocol and do not work if a Mesh node or client device has been switched to WireGuard. Previously this was only documented as a single buried bullet in the high-availability page's Considerations section — this PR surfaces it clearly across the Mesh docs.
Changes
partials/cloudflare-one/mesh/masque-required.mdx), reused as a:::notecallout in:routes.mdx)high-availability.mdx)containers.mdx)routes.mdx)routes.mdx)get-started.mdx(Prerequisites) andclient-devices.mdx(Split Tunnel Include mode list)Notes
🤖 Generated with opencode