[incubator-shenyu-website] branch main updated: doc copy to early version (#344)

[xi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git


The following commit(s) were added to refs/heads/main by this push:
     new f53e4e2  doc copy to early version (#344)
f53e4e2 is described below

commit f53e4e2ccd2ca8b9d3f1431f390ffc3473d175bb
Author: kaitoShy <i...@kaitoshy.com>
AuthorDate: Mon Nov 1 11:13:43 2021 +0800

    doc copy to early version (#344)
---
 .../user-guide/admin-usage/data-permission.md      | 54 ++++++++++++++++++++++
 .../user-guide/admin-usage/role-management.md      | 47 +++++++++++++++++++
 .../user-guide/admin-usage/data-permission.md      | 54 ++++++++++++++++++++++
 .../user-guide/admin-usage/data-permission.md      | 53 +++++++++++++++++++++
 .../user-guide/admin-usage/role-management.md      | 45 ++++++++++++++++++
 .../user-guide/admin-usage/data-permission.md      | 53 +++++++++++++++++++++
 6 files changed, 306 insertions(+)

diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/admin-usage/data-permission.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/admin-usage/data-permission.md
new file mode 100644
index 0000000..3d9c3d6
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/admin-usage/data-permission.md
@@ -0,0 +1,54 @@
+---
+title: 数据权限管理
+keywords: ["用户 插件 数据权限"]
+description: 用户插件数据管理
+---
+
+## 背景与说明
+
+为了实现插件所代理的不同 selector / rule 由不同的业务部门管理,需要对插件的 selector / rule 数据安全针对用户进行控制
+用户未配置数据权限时候,是拥有所有数据权限的, 只要配置了权限就会进行数据权限控制。如下图所示：
+
+<img src="/img/shenyu/basicConfig/dataPermission/data-permission-profile-zh.png" width="80%" height="50%" />
+
+
+## 操作流程
+
+大体的流程如下：
+- 拥有管理用户权限的用户(包含 admin 用户) 新建用户。
+- 拥有管理用户数据权限的用户(包含 admin 用户)点击操作中的 `配置数据权限`。
+> 在此之前请确保插件列表中存在数据。如果没有则需要拥有管理插件权限的用户进行插件数据的增加。
+
+
+接下来我们看下具体操作：
+
+### 新建用户
+
+在点击菜单 "系统管理 -> 用户管理" 展示的页面中新增数据。如下图所示：
+<img src="/img/shenyu/basicConfig/dataPermission/create-user-cn.png" width="80%" height="50%" />
+
+### 编辑数据权限
+
+#### 增加插件数据
+
+在插件列表中增加数据，本文以 `divide` 为例
+<img src="/img/shenyu/basicConfig/dataPermission/plugin-data-cn.png" width="80%" height="50%" />
+
+#### 增加菜单权限
+
+给默认的角色赋予 divide 插件的权限。
+<img src="/img/shenyu/basicConfig/dataPermission/role-permission-cn.png" width="80%" height="50%" />
+
+默认的角色没有任何的菜单权限，如果赋予了用户，该用户将无法登录。将数据权限所在的菜单赋予该角色。
+
+#### 配置用户的数据权限
+
+新增用户后，我们看到普通用户之后会有一个编辑数据权限的按钮，可以对用户进行数据权限的管理。
+<img src="/img/shenyu/basicConfig/dataPermission/permission-setting.png" width="80%" height="50%" />
+
+这里的出现列表就是当时在插件中新增的数据。
+
+### 新用户登录
+
+新用户登录后只能看到已经赋予权限的数据。
+<img src="/img/shenyu/basicConfig/dataPermission/new-user-login-cn.png" width="80%" height="50%" />
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/admin-usage/role-management.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/admin-usage/role-management.md
new file mode 100644
index 0000000..6c1cb50
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/admin-usage/role-management.md
@@ -0,0 +1,47 @@
+---
+title: 用户资源管理
+keywords: ["用户 角色"]
+description: 用户角色管理
+---
+
+本篇主要是讲述 `admin` 控制台通过用户关联的角色，角色赋予菜单和按钮等资源的权限来管理 `admin` 的操作权限。
+<img src="/img/shenyu/basicConfig/roleManagement/role-profile.jpg" width="80%" height="50%" />
+
+## 资源管理
+
+在菜单栏中 ”系统管理 >> 资源管理“ 中增加菜单和按钮。
+
+<img src="/img/shenyu/basicConfig/roleManagement/resource_dashboard.jpg" width="80%" height="50%" />
+
+admin 用户显示了 shenyu 网关所有的菜单和按钮。如果需要自定义增加和删除，先增加菜单，在相应的菜单下，增加按钮。通过点击菜单中右侧的编辑小图标进行菜单的编辑
+
+
+## 角色管理
+
+通过菜单栏 ”系统管理 >> 角色管理“ 来关联角色和资源的权限。 默认会生成两个角色，一个超级管理员，一个普通用户。超级管理员为 admin 用户，不可更改，普通用户的角色可以更改其资源属性。 通过编辑相应的角色，赋予角色相应的菜单和按钮权限。
+
+<img src="/img/shenyu/basicConfig/roleManagement/role_management.jpg" width="80%" height="50%" />
+
+
+## 用户管理
+
+通过菜单栏 ”系统管理 >> 用户管理“ 来管理登录到 admin 的用户。默认为 admin 用户，它拥有所有菜单权限和数据权限，不可更改， 不可删除， 只能修改用户名和密码。
+可以通过按钮 ”新增数据“ 来增加用户。通过选择用户角色来管理该用户登录后所看到的菜单和按钮权限。当用户选择了多个角色时，取所有的角色的最大并集。更改用户的角色权限后，已经登录的用户只要刷新页面便能获得更改后的权限。
+
+下面以新建用户为例，展示了新用户登录后的权限展示。
+
+- 更改默认角色的权限
+
+<img src="/img/shenyu/basicConfig/roleManagement/default-role-permission.jpg" width="80%" height="50%" />
+
+- 新增角色并赋予相应的资源权限
+
+<img src="/img/shenyu/basicConfig/roleManagement/default2-role-permission.jpg" width="80%" height="50%" />
+
+- 新建用户，并赋予相应的角色
+
+<img src="/img/shenyu/basicConfig/roleManagement/add-new-user.jpg" width="80%" height="50%" />
+
+- 用户登录后查看自身的菜单和按钮权限
+
+<img src="/img/shenyu/basicConfig/roleManagement/new-login.jpg" width="80%" height="50%" />
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/admin-usage/data-permission.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/admin-usage/data-permission.md
new file mode 100644
index 0000000..3d9c3d6
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/admin-usage/data-permission.md
@@ -0,0 +1,54 @@
+---
+title: 数据权限管理
+keywords: ["用户 插件 数据权限"]
+description: 用户插件数据管理
+---
+
+## 背景与说明
+
+为了实现插件所代理的不同 selector / rule 由不同的业务部门管理,需要对插件的 selector / rule 数据安全针对用户进行控制
+用户未配置数据权限时候,是拥有所有数据权限的, 只要配置了权限就会进行数据权限控制。如下图所示：
+
+<img src="/img/shenyu/basicConfig/dataPermission/data-permission-profile-zh.png" width="80%" height="50%" />
+
+
+## 操作流程
+
+大体的流程如下：
+- 拥有管理用户权限的用户(包含 admin 用户) 新建用户。
+- 拥有管理用户数据权限的用户(包含 admin 用户)点击操作中的 `配置数据权限`。
+> 在此之前请确保插件列表中存在数据。如果没有则需要拥有管理插件权限的用户进行插件数据的增加。
+
+
+接下来我们看下具体操作：
+
+### 新建用户
+
+在点击菜单 "系统管理 -> 用户管理" 展示的页面中新增数据。如下图所示：
+<img src="/img/shenyu/basicConfig/dataPermission/create-user-cn.png" width="80%" height="50%" />
+
+### 编辑数据权限
+
+#### 增加插件数据
+
+在插件列表中增加数据，本文以 `divide` 为例
+<img src="/img/shenyu/basicConfig/dataPermission/plugin-data-cn.png" width="80%" height="50%" />
+
+#### 增加菜单权限
+
+给默认的角色赋予 divide 插件的权限。
+<img src="/img/shenyu/basicConfig/dataPermission/role-permission-cn.png" width="80%" height="50%" />
+
+默认的角色没有任何的菜单权限，如果赋予了用户，该用户将无法登录。将数据权限所在的菜单赋予该角色。
+
+#### 配置用户的数据权限
+
+新增用户后，我们看到普通用户之后会有一个编辑数据权限的按钮，可以对用户进行数据权限的管理。
+<img src="/img/shenyu/basicConfig/dataPermission/permission-setting.png" width="80%" height="50%" />
+
+这里的出现列表就是当时在插件中新增的数据。
+
+### 新用户登录
+
+新用户登录后只能看到已经赋予权限的数据。
+<img src="/img/shenyu/basicConfig/dataPermission/new-user-login-cn.png" width="80%" height="50%" />
diff --git a/versioned_docs/version-2.4.0/user-guide/admin-usage/data-permission.md b/versioned_docs/version-2.4.0/user-guide/admin-usage/data-permission.md
new file mode 100644
index 0000000..411e84d
--- /dev/null
+++ b/versioned_docs/version-2.4.0/user-guide/admin-usage/data-permission.md
@@ -0,0 +1,53 @@
+---
+title: Data Permission Management
+keywords: ["user data permission"]
+description: user data permission
+---
+## Design Notes
+
+In order to achieve the different selector / rule represented by the plugin managed by different business units, the need for the plugin selector / rule data security for the user to control
+When the user does not configure data permissions, it has all the data permissions, as long as the permissions are configured, the data permissions will be controlled. As shown in the following picture.
+
+<img src="/img/shenyu/basicConfig/dataPermission/data-permission-profile-en.png" width="80%" height="50%" />
+
+
+## How to use
+
+The Brief introduce is as follows.
+- Users with administrative user resouce permissions (including the admin user) create a new user.
+- Users with administrative user data resouce permissions (including admin user) click `ConfigureDataPermission` to manage the user's data permissions.
+> Make sure the data exists in the plugin list before doing so. If not, you will have any data to configure.
+
+Now, let's look how to operation step by step:
+
+### Create User
+
+Clicking the menu "System Manage -> User" to create user, like this:
+<img src="/img/shenyu/basicConfig/dataPermission/create-new-user-en.png" width="80%" height="50%" />
+
+### Edit Date
+
+#### Add Plugin Data
+
+Adding data in the plugin list, this article uses `divide` as an example, like:
+<img src="/img/shenyu/basicConfig/dataPermission/plugin-data-en.png" width="80%" height="50%" />
+
+#### Configure Resource Permission
+
+Giving the `divide` plugin permission to the `default` role.
+<img src="/img/shenyu/basicConfig/dataPermission/role-permission-setting-en.png" width="80%" height="50%" />
+
+The `default` role has none permissions.The user can't login who we set `default` role to. So we must edit the permissons.
+
+#### Configure Data Permission
+
+When we create the common users, we can edit data permissions by the `ConfigureDataPermission` button.
+
+<img src="/img/shenyu/basicConfig/dataPermission/data-permission-en.png" width="80%" height="50%" />
+
+The datas in this list are the same as the plugin list.
+
+## New User Login
+
+When the user login, he just can see the data given to him.
+<img src="/img/shenyu/basicConfig/dataPermission/new-user-login-en.png" width="80%" height="50%" />
diff --git a/versioned_docs/version-2.4.0/user-guide/admin-usage/role-management.md b/versioned_docs/version-2.4.0/user-guide/admin-usage/role-management.md
new file mode 100644
index 0000000..e3fa8f4
--- /dev/null
+++ b/versioned_docs/version-2.4.0/user-guide/admin-usage/role-management.md
@@ -0,0 +1,45 @@
+---
+title: Role Management
+keywords: ["user role resource"]
+description: user role resource permission management
+---
+
+This article focuses on the `admin` console to manage `admin` operation permissions through user-associated roles, roles that give permissions to resources such as menus and buttons.
+<img src="/img/shenyu/basicConfig/roleManagement/role-profile-en.jpg" width="80%" height="50%" />
+
+## Resource
+
+Add Menus and Buttons Resource in "System Manage >> Resouce".
+
+<img src="/img/shenyu/basicConfig/roleManagement/resource-dashboard-en.png" width="80%" height="50%" />
+
+The admin user shows all menus and buttons of the `Shenyu` gateway. If you need to customize adding and removing, add the menu first and under the corresponding menu, add the button. Edit the menu by clicking on the small edit icon on the right side of the menu.
+
+
+## Role
+
+You can associate roles and resource permissions through the menu bar "System Administration >> Role Management". By default, two roles are created, one for super administrator and one for normal user. The super administrator is the admin user, which cannot be changed, and the normal user role can change its resource properties. By editing the corresponding role, you can give the role the appropriate menu and button permissions.
+
+
+## User
+
+You can manage the users logged into admin through the menu bar "System Administration >> User Management". The default user is admin, which has all menu and data permissions, cannot be changed or deleted, and can only change password or username.
+You can add a user by pressing the "Add Data" button. The user role is selected to manage the menu and button permissions that the user sees after logging in. When a user selects more than one role, the maximum set of all roles is taken together. After changing a user's role permissions, users who are already logged in can simply refresh the page to get the changed permissions.
+
+The following is an example of how the new user's permissions.
+
+- editor default user role permission
+
+<img src="/img/shenyu/basicConfig/roleManagement/default-role-en.png" width="80%" height="50%" />
+
+- Add new roles and give the appropriate resource permissions
+
+<img src="/img/shenyu/basicConfig/roleManagement/default2-role-en.png" width="80%" height="50%" />
+
+- Create new users and give them the appropriate roles
+
+<img src="/img/shenyu/basicConfig/roleManagement/add-new-user-en.png" width="80%" height="50%" />
+
+- User login to view their menu and button permissions
+
+<img src="/img/shenyu/basicConfig/roleManagement/new-login-en.png" width="80%" height="50%" />
diff --git a/versioned_docs/version-2.4.1/user-guide/admin-usage/data-permission.md b/versioned_docs/version-2.4.1/user-guide/admin-usage/data-permission.md
new file mode 100644
index 0000000..411e84d
--- /dev/null
+++ b/versioned_docs/version-2.4.1/user-guide/admin-usage/data-permission.md
@@ -0,0 +1,53 @@
+---
+title: Data Permission Management
+keywords: ["user data permission"]
+description: user data permission
+---
+## Design Notes
+
+In order to achieve the different selector / rule represented by the plugin managed by different business units, the need for the plugin selector / rule data security for the user to control
+When the user does not configure data permissions, it has all the data permissions, as long as the permissions are configured, the data permissions will be controlled. As shown in the following picture.
+
+<img src="/img/shenyu/basicConfig/dataPermission/data-permission-profile-en.png" width="80%" height="50%" />
+
+
+## How to use
+
+The Brief introduce is as follows.
+- Users with administrative user resouce permissions (including the admin user) create a new user.
+- Users with administrative user data resouce permissions (including admin user) click `ConfigureDataPermission` to manage the user's data permissions.
+> Make sure the data exists in the plugin list before doing so. If not, you will have any data to configure.
+
+Now, let's look how to operation step by step:
+
+### Create User
+
+Clicking the menu "System Manage -> User" to create user, like this:
+<img src="/img/shenyu/basicConfig/dataPermission/create-new-user-en.png" width="80%" height="50%" />
+
+### Edit Date
+
+#### Add Plugin Data
+
+Adding data in the plugin list, this article uses `divide` as an example, like:
+<img src="/img/shenyu/basicConfig/dataPermission/plugin-data-en.png" width="80%" height="50%" />
+
+#### Configure Resource Permission
+
+Giving the `divide` plugin permission to the `default` role.
+<img src="/img/shenyu/basicConfig/dataPermission/role-permission-setting-en.png" width="80%" height="50%" />
+
+The `default` role has none permissions.The user can't login who we set `default` role to. So we must edit the permissons.
+
+#### Configure Data Permission
+
+When we create the common users, we can edit data permissions by the `ConfigureDataPermission` button.
+
+<img src="/img/shenyu/basicConfig/dataPermission/data-permission-en.png" width="80%" height="50%" />
+
+The datas in this list are the same as the plugin list.
+
+## New User Login
+
+When the user login, he just can see the data given to him.
+<img src="/img/shenyu/basicConfig/dataPermission/new-user-login-en.png" width="80%" height="50%" />