Skip to content

Commit

Permalink
docs: add application tags (#502)
Browse files Browse the repository at this point in the history
  • Loading branch information
Chinoholo0807 authored Jun 30, 2023
1 parent a00fb8c commit 2627f5f
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/application/tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Tags
description: Configure your application tags
keywords: [tags, tag, application]
authors: [Chinoholo0807]
---

The application tags are used to restrict whether users can login the application. Specifically, only users with tags listed in the application tags are allowed to login. For exmaple, applicaiton `dev_app` have tags `dev,prd` , only users with tag `dev` or `prd` can login `dev_app`. Note that admin and global admin are not affected by application tags.

In the application edit page, you can see the `Tags` config and add tags here.

![configure_tags](/img/application/tags/configure_app_tags.png)

Here is a video show you how applicaiton tags work (download to see it):

<video src="/video/application/application_tags.mp4" controls="controls" width="100%"></video>
1 change: 1 addition & 0 deletions docs/application/terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ authors: [ErikQQY]
- `Logo` Application logos will display on the login and sign up page
- `HomepageUrl` The url of the application homepage
- `Description` Describe the application
- `Tags` Only users with tag listed in the application tags can login
- `Organization` The organization that the APP belongs to
- `EnablePassword` If users can login via password
- `EnableSignUp` If users can sign up. If not, accounts of the application
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ module.exports = {
"application/signup-items-tabel",
"application/ui-customization",
"application/specify-login-organization",
"application/tags",
],
},
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/video/application/application_tags.mp4
Binary file not shown.

0 comments on commit 2627f5f

Please sign in to comment.