docs(kanvas): document Help and Support provider and identity preconditions - #1193
Conversation
…itions Kanvas support requests now route through Meshery Server's extension proxy to the remote provider's support intake instead of posting from the browser to a third-party webhook. Two user-visible preconditions resulted and neither was documented. - New Kanvas reference page covering the delivery path, the remote-provider requirement (local provider returns not-implemented), the signed-in identity requirement and its loading state, and the Type of Inquiry vocabulary. - Cross-link from Troubleshooting Kanvas, where Get Help lives. - Note on the self-hosted webhook guide: WEBHOOK_HELP_AND_SUPPORT now also receives Kanvas-originated tickets, same memberFormOne payload. - Drive-by: fix the skipped step number and wording in Step 1 of the webhook guide. Signed-off-by: Lee Calcote <7570704+leecalcote@users.noreply.github.com>
|
Warning Review limit reached
Next review available in: 56 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation adds Kanvas Help and Support guidance, including remote-provider and signed-in identity requirements, request handling, troubleshooting, and retry behavior. The self-hosted webhook guide documents Kanvas-originated requests and updates its configuration steps. ChangesKanvas Help and Support
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@content/en/kanvas/reference/help-and-support.md`:
- Around line 14-16: Specify the text language on the flowchart code fence
containing the Kanvas-to-support-webhook diagram by adding the text fence
annotation, preserving the diagram content unchanged.
- Around line 22-26: Update the Help and Support documentation paragraph to
state that the extension proxy returns HTTP 501 Not Implemented when Meshery
uses the local provider, replacing the vague “rejected as not implemented”
wording while preserving the surrounding provider guidance.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: a912394c-26ae-450b-b458-c17770b375b8
📒 Files selected for processing (3)
content/en/cloud/guides/self-hosted/customizing-webhooks.mdcontent/en/kanvas/reference/help-and-support.mdcontent/en/kanvas/reference/troubleshooting.md
Signed-off-by: Lee Calcote <7570704+leecalcote@users.noreply.github.com>
|
🚀 Preview deployment: https://docs.layer5.io/pr-preview/pr-1193/
|
Description
Documents the Kanvas Help & Support behavior changes shipped in layer5labs/meshery-extensions#4321 (released v1.0.65-2), where support submissions moved from a browser-to-third-party-webhook POST to a Meshery-Server-relayed path (browser -> Meshery Server extension proxy -> Cloud
WEBHOOK_HELP_AND_SUPPORT).Three user-visible consequences, each now findable by a user who hits it:
content/en/kanvas/reference/help-and-support.mdstates this alongside the other Cloud-bound Kanvas features that share the constraint, with remediation.content/en/cloud/guides/self-hosted/customizing-webhooks.mdgains a note thatWEBHOOK_HELP_AND_SUPPORTnow also receives Kanvas-originated tickets, with the samememberFormOnepayload shape, so no webhook-side change is needed.Also cross-linked from
Troubleshooting Kanvas, since Kanvas's Get Help action opens this form.Out of scope drive-by: the webhook guide skipped from "Step 2" to "Step 4"; renumbered, and tidied the Step 1 wording.
Text-only; no fabricated screenshots.
hugobuilds clean locally.Fixes #1192
Signed-off-by: Lee Calcote 7570704+leecalcote@users.noreply.github.com
Summary by CodeRabbit
.envconfiguration and webhook setup steps for self-hosted deployments.