Skip to content

Commit e335ee8

Browse files
authored
feat: Add more descriptions of the databend cloud documents (#3062)
* feat: add more pictures for examples * add export desc
1 parent aeb8329 commit e335ee8

18 files changed

Lines changed: 41 additions & 12 deletions

File tree

docs/cn/guides/10-cloud/02-resources/organization.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,30 @@ title: 组织与成员
3030

3131
## 管理成员
3232

33-
要查看组织中的所有成员,请转到 **管理** > **成员**。此页面提供所有成员的列表,包括他们的电子邮件地址、角色、加入时间和最后活跃时间。如果您是 `account_admin`,您还可以更改成员的角色或从组织中移除成员。
33+
要查看组织中的所有成员,请转到 **管理** > **用户 & 角色**。此页面提供所有成员的列表,包括他们的电子邮件地址、角色、加入时间和最后活跃时间。如果您是 `account_admin`,您还可以更改成员的角色或从组织中移除成员。
3434

3535
- 列出的角色显示用户被邀请时分配给他们的角色。虽然这些角色可以在页面上更改,但无法使用 SQL 撤销。但是,您可以根据用户的电子邮件地址向他们授予额外的角色或权限。这些由电子邮件地址标识的用户账户也可以在 Databend Cloud 中作为 SQL 用户使用。示例:
3636

37-
```sql
38-
GRANT ROLE writer to 'eric@databend.com';
39-
GRANT SELECT ON *.* TO 'eric@databend.com';
40-
```
37+
```sql
38+
GRANT ROLE writer to 'eric@databend.com';
39+
GRANT SELECT ON *.* TO 'eric@databend.com';
40+
```
4141

42-
- 该页面不显示使用 SQL 创建的用户。要查看已创建的 SQL 用户,请使用 [SHOW USERS](/sql/sql-commands/ddl/user/user-show-users) 命令。
42+
- 该页面不显示使用 SQL 创建的用户。要查看已创建的 SQL 用户 ([**CREATE USER**](/sql/sql-commands/ddl/user/user-create-user)[**CREATE ROLE**](/sql/sql-commands/ddl/user/user-create-role)),请使用 [SHOW USERS](/sql/sql-commands/ddl/user/user-show-users) 命令。
4343

4444
### 邀请新成员
4545

46-
要邀请新成员加入您的组织,请导航到 **管理** > **成员** 页面并点击 **邀请新成员**。在出现的对话框中,输入用户的电子邮件地址并从列表中选择一个角色。此列表包括内置角色和为您的组织创建的任何自定义角色。有关角色的更多信息,请参见 [角色](/guides/security/access-control/roles)。
46+
要邀请新成员加入您的组织,请导航到 **管理** > **用户 & 角色** 页面并点击 **邀请新成员**。在出现的对话框中,输入用户的电子邮件地址并从列表中选择一个角色。此列表包括内置角色和为您的组织创建的任何自定义角色。有关角色的更多信息,请参见 [角色](/guides/security/access-control/roles)
4747

4848
邀请邮件将发送给被邀请的用户。邮件中将包含一个链接,用户可以点击该链接启动注册流程。
4949

50+
![Alt text](@site/static/img/documents/overview/invitecn.png)
51+
52+
![Alt text](@site/static/img/documents/overview/invitecn2.png)
53+
5054
:::note
55+
5156
- 邀请新成员加入组织是仅限于 account_admin 角色的权限。
5257

5358
- 如果您的组织使用试用计划,最多允许一个用户。在这种情况下,您将无法邀请其他成员。
54-
:::
59+
:::

docs/cn/guides/10-cloud/02-resources/worksheet.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,14 @@ Databend Cloud 中的工作区(Worksheet)用于组织、运行和保存 SQL
4444
在出现的对话框中,选择共享范围。复制链接分享给目标接收者,他们将收到邮件通知。请注意:如果选择 **Designated Members** 范围,接收者必须单击分享链接才能成功完成共享。
4545

4646
- 查看他人共享的工作区(Worksheet):单击侧边栏的 **Worksheets**,然后选择右侧的 **Shared with Me** 选项卡。
47-
- 共享工作区(Worksheet)后,具备权限的接收者可执行其中 SQL 语句,但无法编辑这些语句。
47+
- 共享工作区(Worksheet)后,具备权限的接收者可执行其中 SQL 语句,但无法编辑这些语句。
48+
49+
## 导出查询结果
50+
51+
Databend Cloud 提供导出查询结果的功能。但此功能需要组织 Owner 为团队成员授予 **EXPORT** 权限。出于数据安全考虑,该功能默认处于禁用状态。
52+
53+
![导出按钮](@site/static/img/documents/worksheet/download.png)
54+
55+
如需使用此功能,请联系组织 Owner 开启相应权限 (**管理** > **用户和角色**):
56+
57+
![导出权限设置](@site/static/img/documents/worksheet/export.png)

docs/en/guides/10-cloud/02-resources/organization.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you're a Databend Cloud user who has accepted invitations from multiple organ
3030

3131
## Managing Members
3232

33-
To view all the members in your organization, go to **Manage** > **Members**. This page provides a list of all members, including their email addresses, roles, join times, and last active times. If you're an `account_admin`, you can also change a member's role or remove a member from your organization.
33+
To view all the members in your organization, go to **Admin** > **Users & Roles**. This page provides a list of all members, including their email addresses, roles, join times, and last active times. If you're an `account_admin`, you can also change a member's role or remove a member from your organization.
3434

3535
- The roles listed show the roles assigned to users when they were invited. While these roles can be changed on the page, they cannot be revoked using SQL. However, you can grant additional roles or privileges to users based on their email addresses. These user accounts, identified by their email addresses, can also function as SQL users in Databend Cloud. Example:
3636

@@ -39,14 +39,18 @@ GRANT ROLE writer to 'eric@databend.com';
3939
GRANT SELECT ON *.* TO 'eric@databend.com';
4040
```
4141

42-
- The page does not display users created using SQL. To view the SQL users that have been created, use the [SHOW USERS](/sql/sql-commands/ddl/user/user-show-users) command.
42+
- The page does not display users created using SQL. To view the SQL users that have been created([**CREATE USER**](/sql/sql-commands/ddl/user/user-create-user)[**CREATE ROLE**](/sql/sql-commands/ddl/user/user-create-role)), use the [SHOW USERS](/sql/sql-commands/ddl/user/user-show-users) command.
4343

4444
### Inviting New Members
4545

46-
To invite a new member to your organization, navigate to the **Manage** > **Members** page and click on **Invite New Member**. In the dialog box that appears, enter the user's email address and select a role from the list. This list includes built-in roles and any created roles created for your organization. For more information about the roles, see [Roles](/guides/security/access-control/roles).
46+
To invite a new member to your organization, navigate to the **Admin** > **Users & Roles** page and click on **Invite New Member**. In the dialog box that appears, enter the user's email address and select a role from the list. This list includes built-in roles and any created roles created for your organization. For more information about the roles, see [Roles](/guides/security/access-control/roles).
4747

4848
An invitation email will be sent to the invited user. Inside the email, there will be a link that the user can click on to initiate the signup process.
4949

50+
![Alt text](@site/static/img/documents/overview/invite.png)
51+
52+
![Alt text](@site/static/img/documents/overview/invite2.png)
53+
5054
:::note
5155

5256
- Inviting new members to the organization is a privilege restricted to account_admin roles only.

docs/en/guides/10-cloud/02-resources/worksheet.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,13 @@ In the dialog box that appears, select the sharing scope. You can copy and share
4646

4747
- To view the worksheets shared with you by others, click **Worksheets** in the sidebar, then click the **Shared with Me** tab on the right.
4848
- When you share a worksheet with others, they can execute the SQL statements in it if they have the necessary permissions, but they won't be able to make any edits to the statements.
49+
50+
## Exporting Query Results
51+
52+
Databend Cloud provides the ability to export query results. However, this feature requires the organization Owner to grant the **EXPORT** permission to team members. For data security purposes, this feature is disabled by default.
53+
54+
![Alt text](@site/static/img/documents/worksheet/download.png)
55+
56+
If you need to use this feature, please contact your organization Owner to enable the permission(**Admin** > **Users & Roles**):
57+
58+
![Alt text](@site/static/img/documents/worksheet/export.png)
-94 KB
Loading
-91 KB
Loading
-156 KB
Loading
53.5 KB
Loading
97.3 KB
Loading
53.9 KB
Loading

0 commit comments

Comments
 (0)