docs(msp): align guides with current portal behavior#12105
docs(msp): align guides with current portal behavior#12105Alan-TheGentleman wants to merge 1 commit into
Conversation
Correct customer, session, role, branding, and lifecycle guidance to match the current Partner Portal implementation.
|
✅ All required changelog fragments are present. |
📝 WalkthroughWalkthroughThis PR updates MSP/MSSP documentation across product overviews and tutorials. It clarifies branding previews, role-based customer and organization actions, customer provisioning, Portal sessions, billing failure guidance, team permissions, and invitation lifecycle descriptions. ChangesMSP and MSSP guide updates
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested reviewers: 🚥 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 |
|
✅ No Conflicts No conflict markers, and the branch merges cleanly into its base. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@docs/user-guide/tutorials/prowler-for-msps-customers.mdx`:
- Line 13: Update the tutorial step describing the Partner Portal UI to begin
with “If you are a Superadmin…”, making the Add Customer action instruction
apply only to Superadmins while preserving the clarification that Organization
Admins do not see it.
🪄 Autofix (Beta)
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: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 5a8aabd7-757e-44fd-8b4f-d5ca7422cd78
📒 Files selected for processing (7)
docs/getting-started/products/prowler-for-msps.mdxdocs/user-guide/tutorials/prowler-for-msps-billing.mdxdocs/user-guide/tutorials/prowler-for-msps-branding.mdxdocs/user-guide/tutorials/prowler-for-msps-customers.mdxdocs/user-guide/tutorials/prowler-for-msps-organization.mdxdocs/user-guide/tutorials/prowler-for-msps-sign-up.mdxdocs/user-guide/tutorials/prowler-for-msps-team.mdx
|
|
||
| <Note> | ||
| Adding a customer is restricted to the Superadmin role. Organization Admins manage existing customers but do not see the **Add Customer** button. | ||
| In the Partner Portal UI, the **Add Customer** action is currently shown to Superadmins. Organization Admins manage existing customers but do not see the action. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the Add Customer instruction role-specific.
Line 13 correctly says Organization Admins do not see Add Customer, but the preceding instruction still tells all readers to click it. Rewrite that step to begin with “If you are a Superadmin…” so Organization Admins are not directed toward an unavailable action.
🤖 Prompt for 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.
In `@docs/user-guide/tutorials/prowler-for-msps-customers.mdx` at line 13, Update
the tutorial step describing the Partner Portal UI to begin with “If you are a
Superadmin…”, making the Add Customer action instruction apply only to
Superadmins while preserving the clarification that Organization Admins do not
see it.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
2 participants
Context
#12101 added the initial Prowler for MSPs and MSSPs documentation. A cross-repository review against the current Partner Portal implementation found several guides describing behavior that is not currently exposed or enforced.
This follow-up aligns the documentation with current observable behavior. It does not change Partner Portal implementation.
Description
Steps to review
Validation performed:
prektrailing-whitespace and end-of-file hooks passed for all changed filesgit diff --checkpassedThe pinned Mint CLI could not start because its ephemeral dependencies omit required runtime packages (
openapi-typesandreact). It failed before reading the documentation; no repository workaround was introduced.Checklist
Community Checklist
docs/**files changedLicense
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Summary by CodeRabbit