docs: add documentation for user center (#290)

提供个人中心的文档。

/kind documentation

Fixes #285 

```release-note
None
```
wan92hen-patch-1
Ryan Wang 12 months ago committed by GitHub
parent a7707ee2ca
commit 8759dafa82
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -25,6 +25,10 @@ Halo 作为一款好用又强大的开源建站工具,配合上不同的模板
5. **功能页面操作区域**:当前所在功能页面提供的功能操作按钮。 5. **功能页面操作区域**:当前所在功能页面提供的功能操作按钮。
6. **功能页面主体** 当前所在功能页面的主体显示区域,显示内容及形式视具体页面功能而定。 6. **功能页面主体** 当前所在功能页面的主体显示区域,显示内容及形式视具体页面功能而定。
## 个人中心
从 Halo 2.11 开始,除了 Console 管理控制台,我们新增加了个人中心,用于管理和用户相关的所有功能。有了个人中心之后,也可以让网站有更多的使用和开发场景,个人中心独立访问入口为 `/uc`
## 文章 ## 文章
文章是 Halo 中的核心概念之一。一篇文章主要由纯文本的文章标题和富文本的文章内容构成,除此之外你还可以为文章设置所属分类、添加标签、设置封面图等。 文章是 Halo 中的核心概念之一。一篇文章主要由纯文本的文章标题和富文本的文章内容构成,除此之外你还可以为文章设置所属分类、添加标签、设置封面图等。

@ -0,0 +1,61 @@
---
title: 个人中心
description: 关于个人中心的功能说明
---
从 Halo 2.11 开始,除了 Console 管理控制台,我们新增加了个人中心,用于管理和用户相关的所有功能。有了个人中心之后,也可以让网站有更多的使用和开发场景。
## 进入个人中心
你可以通过点击 Console 左下角的个人中心图标进入个人中心,也可以直接访问 `/uc` 进入个人中心。
:::info 提示
此外,如果用户拥有进入 Console 的权限,也会在个人中心的左侧导航栏中看到 Console 的入口。
详情可见:[创建角色](./users.md#创建角色)
:::
![Entry](/img/uc/uc-entry.png)
## 个人资料
这个页面会显示和用户相关的一些信息。
![Entry](/img/uc/uc-profile.png)
## 通知配置
这个页面可以配置用户的通知偏好,可以选择接收哪些类型的通知。
![Entry](/img/uc/uc-notification-preferences.png)
## 个人令牌
个人令牌是一种用于访问 Halo API 的凭证,可以通过个人令牌访问 Halo 的 REST API而无需通过用户名和密码授权。
![Entry](/img/uc/uc-pat.png)
创建新的个人令牌:
![Entry](/img/uc/uc-pat-creation.png)
- **名称**:个人令牌的名称。
- **过期时间**:个人令牌的过期时间,不选择则表示永不过期。
- **描述**:个人令牌的描述信息,用于描述个人令牌的用途。
- **权限**:个人令牌的权限,可以选择多个权限。
创建好的个人令牌:
![Entry](/img/uc/uc-pat-token.png)
## 消息
此页面用于显示用户收到的站内消息。
![Entry](/img/uc/uc-notifications.png)
## 我的文章
Halo 默认为个人中心提供了管理个人文章的功能,每个用户都可以在个人中心创建、编辑自己的文章。当然,也可以通过配置角色权限,自行决定是否开放此功能,可查阅[创建角色](./users.md#创建角色)。
![Entry](/img/uc/uc-posts.png)

@ -74,9 +74,16 @@ Halo 提供了全新创建和基于已有角色创建两种角色创建方式。
#### 基于已有角色创建 #### 基于已有角色创建
![基于已有角色创建角色](/img/user-guide/users/role-fork.png)
当系统中已经存在一些基础角色时,你可以点击某个角色所在行中的 `···` 更多操作按钮,选择 `基于此角色创建` 来创建一个新的角色。通过这种方式创建的角色默认继承了原有角色的权限,但你同样可以对新角色的权限进行进一步调整。 当系统中已经存在一些基础角色时,你可以点击某个角色所在行中的 `···` 更多操作按钮,选择 `基于此角色创建` 来创建一个新的角色。通过这种方式创建的角色默认继承了原有角色的权限,但你同样可以对新角色的权限进行进一步调整。
![基于已有角色创建角色](/img/user-guide/users/role-fork.png) ![创建角色](/img/user-guide/users/role-creation.png)
- **名称**:角色的名称。
- **登录之后默认跳转位置**:用户登录成功后,跳转到指定的页面。
- **禁止访问 Console**:勾选后,该角色的用户将无法进入 Console 管理控制台,只能访问个人中心(/uc
- **权限**:角色的权限,可以选择多个权限。
### 修改角色信息 ### 修改角色信息

@ -66,6 +66,7 @@ module.exports = {
}, },
items: [ items: [
"user-guide/common", "user-guide/common",
"user-guide/user-center",
"user-guide/posts", "user-guide/posts",
"user-guide/pages", "user-guide/pages",
"user-guide/attachments", "user-guide/attachments",

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 180 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 536 KiB

@ -25,6 +25,10 @@ Halo 作为一款好用又强大的开源建站工具,配合上不同的模板
5. **功能页面操作区域**:当前所在功能页面提供的功能操作按钮。 5. **功能页面操作区域**:当前所在功能页面提供的功能操作按钮。
6. **功能页面主体** 当前所在功能页面的主体显示区域,显示内容及形式视具体页面功能而定。 6. **功能页面主体** 当前所在功能页面的主体显示区域,显示内容及形式视具体页面功能而定。
## 个人中心
从 Halo 2.11 开始,除了 Console 管理控制台,我们新增加了个人中心,用于管理和用户相关的所有功能。有了个人中心之后,也可以让网站有更多的使用和开发场景,个人中心独立访问入口为 `/uc`
## 文章 ## 文章
文章是 Halo 中的核心概念之一。一篇文章主要由纯文本的文章标题和富文本的文章内容构成,除此之外你还可以为文章设置所属分类、添加标签、设置封面图等。 文章是 Halo 中的核心概念之一。一篇文章主要由纯文本的文章标题和富文本的文章内容构成,除此之外你还可以为文章设置所属分类、添加标签、设置封面图等。

@ -0,0 +1,61 @@
---
title: 个人中心
description: 关于个人中心的功能说明
---
从 Halo 2.11 开始,除了 Console 管理控制台,我们新增加了个人中心,用于管理和用户相关的所有功能。有了个人中心之后,也可以让网站有更多的使用和开发场景。
## 进入个人中心
你可以通过点击 Console 左下角的个人中心图标进入个人中心,也可以直接访问 `/uc` 进入个人中心。
:::info 提示
此外,如果用户拥有进入 Console 的权限,也会在个人中心的左侧导航栏中看到 Console 的入口。
详情可见:[创建角色](./users.md#创建角色)
:::
![Entry](/img/uc/uc-entry.png)
## 个人资料
这个页面会显示和用户相关的一些信息。
![Entry](/img/uc/uc-profile.png)
## 通知配置
这个页面可以配置用户的通知偏好,可以选择接收哪些类型的通知。
![Entry](/img/uc/uc-notification-preferences.png)
## 个人令牌
个人令牌是一种用于访问 Halo API 的凭证,可以通过个人令牌访问 Halo 的 REST API而无需通过用户名和密码授权。
![Entry](/img/uc/uc-pat.png)
创建新的个人令牌:
![Entry](/img/uc/uc-pat-creation.png)
- **名称**:个人令牌的名称。
- **过期时间**:个人令牌的过期时间,不选择则表示永不过期。
- **描述**:个人令牌的描述信息,用于描述个人令牌的用途。
- **权限**:个人令牌的权限,可以选择多个权限。
创建好的个人令牌:
![Entry](/img/uc/uc-pat-token.png)
## 消息
此页面用于显示用户收到的站内消息。
![Entry](/img/uc/uc-notifications.png)
## 我的文章
Halo 默认为个人中心提供了管理个人文章的功能,每个用户都可以在个人中心创建、编辑自己的文章。当然,也可以通过配置角色权限,自行决定是否开放此功能,可查阅[创建角色](./users.md#创建角色)。
![Entry](/img/uc/uc-posts.png)

@ -74,9 +74,16 @@ Halo 提供了全新创建和基于已有角色创建两种角色创建方式。
#### 基于已有角色创建 #### 基于已有角色创建
![基于已有角色创建角色](/img/user-guide/users/role-fork.png)
当系统中已经存在一些基础角色时,你可以点击某个角色所在行中的 `···` 更多操作按钮,选择 `基于此角色创建` 来创建一个新的角色。通过这种方式创建的角色默认继承了原有角色的权限,但你同样可以对新角色的权限进行进一步调整。 当系统中已经存在一些基础角色时,你可以点击某个角色所在行中的 `···` 更多操作按钮,选择 `基于此角色创建` 来创建一个新的角色。通过这种方式创建的角色默认继承了原有角色的权限,但你同样可以对新角色的权限进行进一步调整。
![基于已有角色创建角色](/img/user-guide/users/role-fork.png) ![创建角色](/img/user-guide/users/role-creation.png)
- **名称**:角色的名称。
- **登录之后默认跳转位置**:用户登录成功后,跳转到指定的页面。
- **禁止访问 Console**:勾选后,该角色的用户将无法进入 Console 管理控制台,只能访问个人中心(/uc
- **权限**:角色的权限,可以选择多个权限。
### 修改角色信息 ### 修改角色信息

@ -48,6 +48,7 @@
}, },
"items": [ "items": [
"user-guide/common", "user-guide/common",
"user-guide/user-center",
"user-guide/posts", "user-guide/posts",
"user-guide/pages", "user-guide/pages",
"user-guide/attachments", "user-guide/attachments",

Loading…
Cancel
Save