mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-28 00:06:53 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
26 lines
1.4 KiB
Plaintext
26 lines
1.4 KiB
Plaintext
---
|
|
title: Public Invite Links
|
|
---
|
|
|
|
Public invite links let you invite team members to your Unleash instance. Any user with an invite link can sign up to Unleash instance that created the link. The user will get the **viewer** role (refer to the [_standard roles_ section of the RBAC document](../reference/rbac.md#standard-roles) for more information on roles).
|
|
|
|
User who follow the invite link are taken directly to the Unleash sign-up page, where they can create an account.
|
|
|
|
Only **Unleash instance admins** can create public invite links.
|
|
|
|
|
|
|
|
## Public sign-up tokens
|
|
|
|
The most important part of a public sign-up link is the sign-up token. The token is added as the `invite` query parameter to the invite link.
|
|
|
|
Each token has an **expiry date**. After this expiry date, the token will stop working and users can no longer sign up using an invite link with that token.
|
|
|
|
## Creating, updating, and deleting tokens
|
|
|
|
You can [create, update and delete tokens via the Unleash Admin UI](../how-to/how-to-manage-public-invite-tokens.mdx) or via the [Unleash API](../reference/api/unleash/public-signup-tokens.tag.mdx "Public sign-up tokens API documentation").
|
|
|
|
A token is active as soon as it's created and stops working as soon as it's deleted or expired.
|
|
|
|
You can only have one active invite token at a time. If you already have an active token, you must delete it to create a new one.
|