Skip to content

Commit

Permalink
docs: add organization tree & group docs (#495)
Browse files Browse the repository at this point in the history
* docs: add groups document

* docs: add groups document

* Update organization-tree.md

* Update sidebars.js

---------

Co-authored-by: hsluoyz <[email protected]>
  • Loading branch information
leo220yuyaodog and hsluoyz authored Jun 16, 2023
1 parent e74d8c5 commit ce9c28f
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/organization/organization-tree.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Organization Tree
description: the user's groups
keywords: [user, group, organization, tree]
authors: [leo220yuyaodog]
---

Groups is a collection of users under an organization. A user can be in multiple groups.

## Group properties

- `Owner` Owner organization of the group
- `Name` Group name (unique)
- `displayName`
- `CreatedTime`
- `UpdatedTime`
- `Type` Groups have two types: `Phsical` and `Vertual`, a use can only be in one `Phsical` group, but can be in multiple `Vertual` groups.
- `ParentGroup` Parent group of the group (The parent group of top groups in the organization is the organization itself)

## Manage groups

There are two ways to manage groups:
1. In the groups list pages, you can see all the groups in organizations.

![groups list](/img/organization/oganization_tree/groups_list.png)

2. Click the **Groups** button in organization list page

![organization list](/img/organization/oganization_tree/organization_tree_entry.png)

Then you can see the tree structure of the groups in the organization.

![groups tree](/img/organization/oganization_tree/groups_tree.png)

Here is a video show you how to manage groups:

![groups tree page](/img/organization/oganization_tree/groups_tree.gif)

Groups can be also edit in user profile.

![groups user](/img/organization/oganization_tree/groups_user.png)




1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ module.exports = {
link: {type: "generated-index"},
items: [
"organization/overview",
"organization/organization-tree",
"organization/accountCustomization",
"organization/customize-theme",
"organization/mfa-items",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ce9c28f

Please sign in to comment.