Skip to content

Add "Open Team Invite" section to Teams documentation #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 24, 2025

Conversation

zihanKuang
Copy link
Contributor

Notes for Reviewers

This PR fixes #560

This PR introduces a new section detailing the "Open Team Invite" feature on the Teams documentation page.

Key changes include:

  • Addition of an "Open Team Invite" section explaining its purpose, how it ideally works (including user onboarding scenarios), and its benefits.
  • Inclusion of a GIF (open_team_invite.gif) to visually illustrate the process.
  • An alert box to differentiate "Open Team Invite" from "Open Org Invite Link" for users whose goal is organization-specific invitations.
  • Minor formatting update.

zihanKuang and others added 5 commits May 18, 2025 12:15
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
Copy link

netlify bot commented May 18, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 35d9e75
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/68309120e8dd860008704fc9
😎 Deploy Preview https://deploy-preview-569--bejewelled-pegasus-b0ce81.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.

Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com>
## Open Team Invite

The "Open Team Invite" feature allows administrators to enable a specific invitation method for users to join a particular team. This is intended to function like an [Open Org Invite Link](https://docs.layer5.io/cloud/identity/users/user-management/), but for a specific team, providing a direct way to invite members rather than adding them manually.
Copy link
Member

Choose a reason for hiding this comment

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

"a specific invitation method" - perhaps, this could be made into less abstract phrasing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The current UI still uses a checkbox,and it hasn't been fixed. I'm unsure what the intended UI element should be.

## Open Team Invite

The "Open Team Invite" feature allows administrators to enable a specific invitation method for users to join a particular team. This is intended to function like an [Open Org Invite Link](https://docs.layer5.io/cloud/identity/users/user-management/), but for a specific team, providing a direct way to invite members rather than adding them manually.
Copy link
Member

Choose a reason for hiding this comment

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

"intended to"? Rather, "does".

![Process of open team invite](/cloud/identity/teams/open_team_invite.gif)

### Why Use Open Team Invite
Copy link
Member

Choose a reason for hiding this comment

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

Refine your AI output, please.

Let's not call it "Open Team Invite".

### Why Use Open Team Invite

* **Effortless Onboarding to Teams:** Provides a single invitation link that seamlessly guides users through account creation (if new), organization membership, and directly into the specific team.
Copy link
Member

Choose a reason for hiding this comment

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

This is marketing fluff and AI generated content that is of little value. These are docs, not marketing website.

Focus on how the feature works, when to use it, best practices of using it and any caveats of its use.

### How Open Team Invite Works

1. **Copy Team Invite Link:** After clicking the relevant UI element, the link is copied to your clipboard.[^1]
Copy link
Member

Choose a reason for hiding this comment

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

"After clicking the relevant UI element," - - too abstract.

Do we really need to tell our users that when they click "the relevant UI element" (the copy link button) that the link is then copied to clipboard? 🫤

Less AI, more Zihan.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The current UI still uses a checkbox,and it hasn't been fixed. I'm unsure what the intended UI element should be.

@leecalcote
Copy link
Member

Thank you for the animated gif. In this case, a screenshot of the Edit Team window, perhaps, would have been just as effective.

zihanKuang and others added 3 commits May 18, 2025 20:15
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com>
Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com>
@zihanKuang zihanKuang merged commit fd9aaeb into layer5io:master May 24, 2025
6 checks passed
@zihanKuang zihanKuang deleted the open-team-invite branch May 24, 2025 18:52
leecalcote pushed a commit that referenced this pull request Jun 10, 2025
Add "Open Team Invite" section to Teams documentation
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.

[Docs] Open Team Invite
2 participants