Skip to content

docs(kanvas): document Help and Support provider and identity preconditions - #1193

Merged
leecalcote merged 2 commits into
masterfrom
fm/kanvas-support-docs
Aug 7, 2026
Merged

docs(kanvas): document Help and Support provider and identity preconditions#1193
leecalcote merged 2 commits into
masterfrom
fm/kanvas-support-docs

Conversation

@leecalcote

@leecalcote leecalcote commented Aug 7, 2026

Copy link
Copy Markdown
Member

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:

  1. Help and Support requires a remote provider. The submission traverses Meshery Server's extension proxy, which returns not-implemented under the local provider. New page content/en/kanvas/reference/help-and-support.md states this alongside the other Cloud-bound Kanvas features that share the constraint, with remediation.
  2. The form requires a resolved signed-in identity. The profile is fetched when the dialog opens (loading state shown); if it cannot be resolved the form is withheld and nothing is submitted. Same page, with remediation.
  3. Self-hosted addendum. content/en/cloud/guides/self-hosted/customizing-webhooks.md gains a note that WEBHOOK_HELP_AND_SUPPORT now also receives Kanvas-originated tickets, with the same memberFormOne payload 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. hugo builds clean locally.

Fixes #1192

Signed-off-by: Lee Calcote 7570704+leecalcote@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Clarified .env configuration and webhook setup steps for self-hosted deployments.
    • Expanded Help and Support webhook guidance, including request routing, provider requirements, testing, and troubleshooting.
    • Added Kanvas Help and Support documentation covering request categories, loading and failure behavior, and form data preservation.
    • Added troubleshooting guidance for the Get Help action, including remote provider and sign-in requirements.

…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>
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@leecalcote, you've reached your PR review limit, so we couldn't start this review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ac5c5a18-ec63-43aa-aab3-1c942b5e28c9

📥 Commits

Reviewing files that changed from the base of the PR and between e878b75 and a1d9b28.

📒 Files selected for processing (1)
  • content/en/kanvas/reference/help-and-support.md
📝 Walkthrough

Walkthrough

The 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.

Changes

Kanvas Help and Support

Layer / File(s) Summary
Document Kanvas support requirements
content/en/kanvas/reference/help-and-support.md, content/en/kanvas/reference/troubleshooting.md
The documentation describes request routing, prerequisites, loading and failure behavior, inquiry categories, troubleshooting, and retry behavior.
Document Kanvas webhook handling
content/en/cloud/guides/self-hosted/customizing-webhooks.md
The webhook guide includes Kanvas help-and-support submissions, documents the memberFormOne payload and remote-provider requirement, corrects the .env description, and renumbers configuration steps.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the Kanvas Help and Support provider and identity documentation, matching the primary changes.
Linked Issues check ✅ Passed The documentation covers remote-provider and signed-in identity preconditions, Kanvas tickets, and the shared memberFormOne payload [#1192].
Out of Scope Changes check ✅ Passed All changes are documentation updates directly related to issue #1192, with no unrelated changes identified.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fm/kanvas-support-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between f8c3300 and e878b75.

📒 Files selected for processing (3)
  • content/en/cloud/guides/self-hosted/customizing-webhooks.md
  • content/en/kanvas/reference/help-and-support.md
  • content/en/kanvas/reference/troubleshooting.md

Comment thread content/en/kanvas/reference/help-and-support.md Outdated
Comment thread content/en/kanvas/reference/help-and-support.md Outdated
Signed-off-by: Lee Calcote <7570704+leecalcote@users.noreply.github.com>
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

🚀 Preview deployment: https://docs.layer5.io/pr-preview/pr-1193/

Note: Preview may take a moment (GitHub Pages deployment in progress). Please wait and refresh. Track deployment here

@leecalcote
leecalcote merged commit d090c7e into master Aug 7, 2026
5 checks passed
@leecalcote
leecalcote deleted the fm/kanvas-support-docs branch August 7, 2026 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Kanvas Help & Support: remote-provider requirement, signed-in identity requirement, and Kanvas-originated tickets on WEBHOOK_HELP_AND_SUPPORT

2 participants