Skip to content

Add docs for EP auto-invite on customer creation#3896

Open
AmberAlston wants to merge 4 commits intomainfrom
add-ep-auto-invite-ability
Open

Add docs for EP auto-invite on customer creation#3896
AmberAlston wants to merge 4 commits intomainfrom
add-ep-auto-invite-ability

Conversation

@AmberAlston
Copy link
Member

@AmberAlston AmberAlston commented Mar 18, 2026

Preview link: https://deploy-preview-3896--replicated-docs.netlify.app/vendor/enterprise-portal-invite#auto-invite & https://deploy-preview-3896--replicated-docs.netlify.app/vendor/releases-creating-customer

Summary

  • Adds new "Automatically invite customers on creation" section to the Manage Enterprise Portal customer access page, covering the app-level toggle, per-customer override, and RBAC permission note
  • Adds tip box to the "Invite users" section cross-referencing auto-invite
  • Adds tip box to the Create and manage customers page noting the auto-invite checkbox on the Create Customer form

Related PR: https://github.com/replicatedhq/vandoor/pull/9182

Test plan

  • Review content accuracy against PR #9182 implementation
  • Verify anchor links resolve correctly (#auto-invite, #create-a-customer)
  • Confirm tip/note formatting renders properly

🤖 Generated with Claude Code

Documents the new ability to automatically send Enterprise Portal
invitations when creating customers, including the app-level toggle,
per-customer override on the Create Customer page, and RBAC
permission requirements.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@netlify
Copy link

netlify bot commented Mar 18, 2026

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 3c344c3
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/69bc166556e62a0008a727de
😎 Deploy Preview https://deploy-preview-3896--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Mar 18, 2026

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 3c344c3
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/69bc16659edf7b0008fb2aff
😎 Deploy Preview https://deploy-preview-3896--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Mar 18, 2026
@AmberAlston
Copy link
Member Author

Side note. This is a permissions thing I'm getting some input on. It's accurate for as-is. We may do follow up work here that may change or remove this note

image

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
A customer email address is required for Helm installations. This email address is never used to send emails to customers.
:::

:::note
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@AmberAlston
Copy link
Member Author

@paigecalvert this double note thing feels weird to me. Should we combine? I'm leaning towards that but it will be a long note. This is the customer create/manage page part of the change. What do you think? Otherwise ready to review

image

@AmberAlston AmberAlston marked this pull request as ready for review March 19, 2026 00:14
@AmberAlston AmberAlston requested a review from a team as a code owner March 19, 2026 00:14

:::note
The **Send Enterprise Portal invite to customer email** checkbox appears only when the Enterprise Portal is enabled globally for all customers. For more information, see [Automatically invite customers on creation](enterprise-portal-invite#auto-invite) in _Manage Enterprise Portal customer access_.
:::
Copy link
Contributor

Choose a reason for hiding this comment

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

^ @AmberAlston see what you think about this solution to the double note issue. Seemed like the mention of auto invite could be bumped out into it's own optional step, since it's a separate decision

Copy link
Member Author

Choose a reason for hiding this comment

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

i like this thanks

1. For **Customer name**, enter a name for the customer.

1. For **Customer email**, enter the email address for the customer.
1. For **Customer email**, enter the email address for the customer. A customer email address is required for Helm installations. This email address is never used to send emails to customers.
Copy link
Contributor

Choose a reason for hiding this comment

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

(also decided that this one about the email being required for Helm installs didn't need to be a note)


#### Requirements
* Enable the **Enterprise Portal > Customer Access > Enable Enterprise Portal for all customers** setting. Disabling this setting automatically turns off automatic invitations. See [Enable the Enterprise Portal globally](#enable-global) on this page.
* Ensure that you have the Enterprise Portal invite RBAC permission. If the user creating the customer does not have this permission, then the automatic invitation checkbox on the **Create a new customer** page is disabled and the Enterprise Portal does not send the automatic invitation. For more information about configuring RBAC policies, see [Configuring RBAC policies](team-management-rbac-configuring).
Copy link
Contributor

Choose a reason for hiding this comment

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

Sounded like this one is somewhat TBD? I didn't see the invite permission documented yet

Copy link
Contributor

Choose a reason for hiding this comment

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

Also a meta comment: I'm thinking about how much we want to list out the RBAC permissions required for all these new features. It's not something that we do for any other vendor portal actions. For example, we make no mention of rbac permissions on the docs pages for things like creating and managing channels/releases/customers. I'm leaning towards only mentioning RBAC permissions in the Configuring RBAC section of the docs in favor of not having to list out (and then keep up to date) every rbac permission required for everything. What do you think?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes i agree with that from an ongoing maintainability perspective. We primarily started listing them recently because we were getting explicitly asked by early adopters of things like notifications that needed to know what exact new/existing RBAC permissions to add to their custom policies that don't get automatically updated

Copy link
Member Author

Choose a reason for hiding this comment

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

We're going to do this follow up story this week to correct the main permissions disconnect in the sales role. After this is done we may not need this because all the default roles that can create customers will be able to invite those users to EP. https://app.shortcut.com/replicated/story/135768/follow-up-on-ep-auto-invite-permission-disconnect

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants