Skip to content

docs(partner-portal): Partner Portal documentation (PP-323)#10999

Open
pap-nazaries wants to merge 3 commits into
prowler-cloud:masterfrom
pap-nazaries:docs/pp-323-partner-portal-docs
Open

docs(partner-portal): Partner Portal documentation (PP-323)#10999
pap-nazaries wants to merge 3 commits into
prowler-cloud:masterfrom
pap-nazaries:docs/pp-323-partner-portal-docs

Conversation

@pap-nazaries

@pap-nazaries pap-nazaries commented May 5, 2026

Copy link
Copy Markdown

Context

Adds Prowler Partner Portal user-facing documentation to docs.prowler.com. Prowler Partner Portal is a separate product (partners.prowler.com) for resellers, MSPs and consultants to onboard customers and operate Prowler Cloud tenants on their behalf — until now there was no first-party documentation for it on docs.prowler.com.

Implements epic PP-323 and its 6 child tasks: PP-320, PP-324, PP-325, PP-326, PP-327, PP-328.

Description

Adds 6 new MDX pages and updates docs/docs.json with two new dedicated groups under the "Prowler Partner Portal" name. Partner Portal is a separate product (different audience, URL, API, branding), so its docs are grouped together rather than interleaved inside Prowler Cloud/App.

Pages added:

Task Path
PP-320 — Overview docs/getting-started/products/prowler-partner-portal.mdx
PP-324 — Sign-up & sign-in docs/user-guide/tutorials/partner-portal-sign-up.mdx
PP-325 — Team & roles docs/user-guide/tutorials/partner-portal-team.mdx
PP-326 — Partner organization docs/user-guide/tutorials/partner-portal-organization.mdx
PP-327 — Customer onboarding & access docs/user-guide/tutorials/partner-portal-customer-onboarding.mdx
PP-328 — Branding docs/user-guide/tutorials/partner-portal-branding.mdx

docs/docs.json adds two groups:

  • Getting Started → new Prowler Partner Portal group, between Prowler Lighthouse AI and Prowler MCP Server.
  • Guides → new Prowler Partner Portal group at top level, sibling of Prowler Cloud/App, CI/CD, CLI, Providers, Compliance, Cookbooks.

Steps to review

  1. Check out the branch and run cd docs && npm install -g mint && mint dev.
  2. Open http://localhost:3000 and verify:
    • Getting Started sidebar shows the new Prowler Partner Portal group between Prowler Lighthouse AI and Prowler MCP Server; the Overview page renders at /getting-started/products/prowler-partner-portal.
    • Guides sidebar shows a new top-level Prowler Partner Portal group with 5 entries in this order: Sign-up → Organization → Team → Branding → Customer onboarding.
  3. On the Your partner organization page, click the in-text link to Customise Partner Portal branding and verify it resolves without 404 (the only internal cross-link between Partner Portal pages).
  4. Optionally check the Mintlify preview deploy posted on this PR by the Mintlify GitHub App.

Checklist

Community Checklist
  • This feature/issue is listed in here or roadmap.prowler.com
  • Is it assigned to me, if not, request it via the issue/feature in here or Prowler Community Slack

SDK/CLI

  • Are there new checks included in this PR? No — docs-only PR.
    • If so, do we need to update permissions for the provider? Please review this carefully.

UI

  • All issue/task requirements work as expected on the UI
  • Screenshots/Video of the functionality flow (if applicable) - Mobile (X < 640px)
  • Screenshots/Video of the functionality flow (if applicable) - Table (640px > X < 1024px)
  • Screenshots/Video of the functionality flow (if applicable) - Desktop (X > 1024px)
  • Ensure new entries are added to CHANGELOG.md, if applicable.

API

  • All issue/task requirements work as expected on the API
  • Endpoint response output (if applicable)
  • EXPLAIN ANALYZE output for new/modified queries or indexes (if applicable)
  • Performance test results (if applicable)
  • Any other relevant evidence of the implementation (if applicable)
  • Verify if API specs need to be regenerated.
  • Check if version updates are required (e.g., specs, Poetry, etc.).
  • Ensure new entries are added to CHANGELOG.md, if applicable.

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Adds Prowler Partner Portal user-facing documentation to docs.prowler.com
under a new dedicated "Prowler Partner Portal" group, mirroring the
Getting Started product grouping.

Pages added:

- PP-320 Overview: getting-started/products/prowler-partner-portal.mdx
- PP-324 Sign-up: user-guide/tutorials/partner-portal-sign-up.mdx
- PP-325 Team: user-guide/tutorials/partner-portal-team.mdx
- PP-326 Organization: user-guide/tutorials/partner-portal-organization.mdx
- PP-327 Customer onboarding: user-guide/tutorials/partner-portal-customer-onboarding.mdx
- PP-328 Branding: user-guide/tutorials/partner-portal-branding.mdx

docs/docs.json adds two new groups:

- Getting Started → "Prowler Partner Portal" between Lighthouse AI and MCP Server
- Guides → "Prowler Partner Portal" between Prowler Cloud/App and CI/CD

Refs PP-323
@pap-nazaries pap-nazaries requested a review from a team as a code owner May 5, 2026 09:11
@github-actions github-actions Bot added documentation community Opened by the Community labels May 5, 2026
@github-actions

github-actions Bot commented May 5, 2026

Copy link
Copy Markdown
Contributor

Conflict Markers Resolved

All conflict markers have been successfully resolved in this pull request.

@HugoPBrito HugoPBrito self-assigned this May 6, 2026

@HugoPBrito HugoPBrito left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the work on this — solid coverage of the epic. I've left a few inline comments to tighten consistency with the rest of docs/. The recurring patterns to align on are:

  • US English spelling (Customize, white-labeling) — repo grep: 4× Customize, 0× Customise.
  • Title Case in frontmatter titles and ##/### headings, matching prowler-app-rbac.mdx, aws-organizations-bulk-provisioning.mdx, prowler-mcp.mdx, etc.
  • Markdown links for URLs in prose (we don't usually leave bare https://... inline).
  • ## Next Steps block at the end of each page using <Columns cols={2}> + <Card>, like other overviews/tutorials.

I've grouped these per file in the inline comments below, plus a few content-level nits. Happy to re-review once you've had a look.

Comment thread docs/getting-started/products/prowler-partner-portal.mdx Outdated
Comment thread docs/user-guide/tutorials/partner-portal-sign-up.mdx Outdated
Comment thread docs/user-guide/tutorials/partner-portal-organization.mdx Outdated
Comment thread docs/user-guide/tutorials/partner-portal-team.mdx Outdated
Comment thread docs/user-guide/tutorials/partner-portal-team.mdx Outdated
Comment thread docs/user-guide/tutorials/partner-portal-branding.mdx Outdated
Comment thread docs/user-guide/tutorials/partner-portal-customer-onboarding.mdx Outdated
Comment thread docs/user-guide/tutorials/partner-portal-customer-onboarding.mdx
Comment thread docs/user-guide/tutorials/partner-portal-customer-onboarding.mdx
Comment thread docs/docs.json
- Apply Title Case to frontmatter titles and section headings
- Use US English (customize, white-labeling, catalog)
- Convert bare URLs to Markdown links
- Add Next Steps Cards section to all six pages
- Add rocket icon to overview Card and architecture-diagram TODO
- Convert Team page permissions list to a table
- Fix only/all contradiction on customer-onboarding page
- Replace inline providers list with link to prowler-app#components
- Reorder sidebar: Sign-up, Team, Organization, Branding, Customer onboarding
@pap-nazaries pap-nazaries requested a review from HugoPBrito May 6, 2026 10:10
@pap-nazaries

Copy link
Copy Markdown
Author

Thanks for the thorough review @HugoPBrito — really appreciated. I've pushed a56bde23e addressing every point. Quick rundown:

Global patterns

  • ✅ US English: Customize / customize / white-labeling / catalog (also caught two stray catalogue instances in partner-portal-team.mdx and partner-portal-organization.mdx).
  • ✅ Title Case applied to all 6 frontmatter titles and ## headings.
  • ✅ Bare URLs wrapped as Markdown links (partners.prowler.com/..., cloud.prowler.com).
  • ## Next Steps block with <Columns cols={2}> + <Card> added to all 6 pages, cross-linked along the Sign-up → Team → Organization → Branding → Customer onboarding lifecycle.

Per-file

  • prowler-partner-portal.mdx: icon="rocket" on the sign-up Card; added {/* TODO: Add architecture diagram */} placeholder per your suggestion.
  • partner-portal-sign-up.mdx: dropped the ? from the heading (kept inline references to the Forgot password? button label).
  • partner-portal-organization.mdx: anchor text now [Customizing Partner Portal Branding] to match the renamed page.
  • partner-portal-team.mdx: permissions bullet list converted to a table matching prowler-app-rbac.mdx:221.
  • partner-portal-customer-onboarding.mdx:
    • L9 contradiction fixed — now reads "the page is visible to all signed-in partner users; the + Add Customer button on the toolbar requires the manage_organizations permission."
    • L26 inline providers list replaced with a single link to supported providers.

Sidebar (docs.json)

  • Took the heads-up and reordered to follow the lifecycle: Sign-up → Team → Organization → Branding → Customer onboarding.

Ready for another pass whenever you have a minute. 🙏

HugoPBrito
HugoPBrito previously approved these changes May 6, 2026

@HugoPBrito HugoPBrito left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the thorough pass — every consistency point is addressed and the lifecycle ordering in docs.json is a nice touch. The phrasing on ## Accessing a Customer Tenant on Behalf of the Customer is clearer than what I suggested. LGTM.

…roduct (PP-323)

Apply PP-362 role rename and the partner-facing terminology pass:

- Admin → Superadmin; Member → Organization Admin (UI labels).
- Drop the 1:1 mapping to Cloud Manager/Operator from /team docs;
  the Cloud-side level is now provisioned automatically and managed
  in Prowler Cloud, not chosen at invitation time.
- Update permission matrix: Organization Admin gains manage_billing,
  manage_organizations and access_tenants — it is no longer read-only.
- Replace "tenant" with "customer workspace" in partner-facing prose,
  keeping backend identifiers (access_tenants flag, on_behalf_of claim).

Workspaces are intentionally left out of the user-facing matrix —
the /workspaces sidebar entry is still filtered out of the menu, so
manage_workspaces and access_all_workspaces are not documented yet.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community Opened by the Community documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants