Browse Source

✨ 完善文档

pull/71/head
王军 4 years ago
parent
commit
570401d763
  1. 16
      docs/content/about/release-notes.md
  2. 5
      docs/content/index.md
  3. 47
      docs/content/user-guide/zh/getting-started/quick-start.md
  4. 19
      docs/content/user-guide/zh/modules/basic.md
  5. 39
      docs/content/user-guide/zh/modules/identity.md
  6. 2
      docs/mkdocs.yml

16
docs/content/about/release-notes.md

@ -1,5 +1,21 @@
# 发行说明
## 5.3.2.7
**功能**
* 封装abp 自带模板到BasicManagement
## 5.3.2.5
**功能**
* 移除IdentityServer4 #45
**Bug**
* 导出用户权限错误
## 5.3.2.4
**Bug**

5
docs/content/index.md

@ -19,11 +19,6 @@ Title: Abp Vnext Pro
- [x] 审计日志
- [x] 后台任务
- [x] 集成事件
- [ ] IdentityServer4
* [x] 客户端管理
* [x] Api 资源管理
* [x] ApiScope 管理
* [x] Identity 资源管理
- [x] SinglaR 消息通知(站内信)
- [x] 多语言
- [x] 数据字典

47
docs/content/user-guide/zh/getting-started/quick-start.md

@ -8,23 +8,49 @@
- [redis](https://redis.io/docs/getting-started/installation/)
- [rabbitmq 可选](https://www.rabbitmq.com/download.html)
!!! info "Docker一键安装Mysql|Redis|Rabbitmq"
快速搭建必要环境,下载 [docker-compose.yaml](docker-compose.yaml) , 执行: docker-compose up -d
## Docker启动MySql
``` bash
docker run --name mymysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=1q2w3E* -d mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
```
## Docker启动Redis
``` bash
docker run --name myredis -p 6379:6379 -d redis:latest redis-server
```
## Docker启动RabbitMq
``` bash
docker run -d --name myrabbitmq -e RABBITMQ_DEFAULT_USER=admin -e RABBITMQ_DEFAULT_PASS=admin -p 15672:15672 -p 5672:5672 rabbitmq:management
```
## 创建新项目
### 直接Clone
### 安装Cli工具
- [仓库地址](https://github.com/WangJunZzz/Lion.AbpPro.Cli)
``` bash
git clone https://github.com/WangJunZzz/abp-vnext-pro.git
dotnet tool install Lion.AbpPro.Cli -g
```
或者
### 生成项目
**提供了三个模板生成**
- 生成源码版本
```bash
lion.abp new abp-vnext-pro -c 公司名称 -p 项目名称 -o 输出路径(可选) -v 版本号(可选)
```
- nuget包形式的基础版本,包括abp自带的所有模块,已经pro的通知模块,数据字典模块 以及ocelot网关
```bash
lion.abp new abp-vnext-pro-basic -c 公司名称 -p 项目名称 -v 版本(默认LastRelease) -o 项目输出路径(可选).
```
- nuget包形式的基础版本,包括abp自带的所有模块,已经pro的通知模块,数据字典模块 无ocelot网关
```bash
lion.abp new abp-vnext-pro-basic-no-ocelot -c 公司名称 -p 项目名称 -v 版本(默认LastRelease) -o 项目输出路径(可选).
```
### GUI创建项目
![](https://blog-resouce.oss-cn-shenzhen.aliyuncs.com/images/abp/gui.png)
### 后端
- 修改 HttpApi.Host-> appsettings.json 配置
@ -46,9 +72,6 @@
如果不需要使用Ocelot网关可以移除Lion.AbpPro.WebGateway项目,前端接口地址直接修改为Lion.AbpPro.HttpApi.Host的接口地址。
!!! note IdentityServer4
如果不需要使用IdentityServer4可以移除Lion.AbpPro.IdentityServer项目,请参考如何如何移除IdentityServer4
- 多项目启动(HttpApi.Host,IdentityServer,WebGateway),就能看到后台服务登陆页面,如下:
![](../../../img/login.png)

19
docs/content/user-guide/zh/modules/basic.md

@ -0,0 +1,19 @@
# 基础模块
- 把abp自带 账户模块,权限模块,identity模块,setting模块,feature模块,后台任务模块,租户模块封装到BasicManagement
## 安装
- Lion.Abp.BasicManagement.Application
- Lion.Abp.BasicManagement.Application.Contracts
- Lion.Abp.BasicManagement.Domain
- Lion.Abp.BasicManagement.Domain.Shared
- Lion.Abp.BasicManagement.EntityFrameworkCore
- Lion.Abp.BasicManagement.HttpApi
- Lion.Abp.BasicManagement.HttpApi.Client
## 模块依赖
- 添加 DependsOn(typeof(BasicManagementXxxModule)) 特性到对应模块。
- 在EntityFrameworkCore层添加数据库配置在AbpProDbContext.cs的OnModelCreating()方法中添加builder.ConfigureBasicManagement();

39
docs/content/user-guide/zh/modules/identity.md

@ -1,39 +0,0 @@
# 身份管理模块
- 身份模块基于 [Microsoft Identity](https://docs.microsoft.com/zh-cn/aspnet/core/security/authentication/identity?view=aspnetcore-6.0) 库 用于管理角色,用户及其权限.
## 用户
- 此页用于查看用户列表. 您可以创建/编辑和删除用户, 将角色分配给用户。
![](../../../img/user.png)
- 一个用户可以有零个或多个角色. 用户从其角色继承权限 。
## 角色
- 角色用于按分组给用户分配权限.
![](../../../img/role.png)
- 角色除了角色名称之外还有2个属性:
- Default: 如果某个角色被标记为 "default", 那么当新用户注册到应用程序时, 其将被作为默认角色分配给新用户.
- Public: 用户的公共角色可以被应用程序中的其他用户看到. 这个功能在身份模块中没有用到, 但被提供作为你可能希望在你自己的应用程序中使用的功能.
## 组织单元
- 组织单元由 OrganizationUnit 实体表示. 它的基本属性是:
- TenantId: 组织单元的租户Id. 对于宿主可以是 null.
- ParentId: 父级组织单元的Id. 如果这是一个根级组织单元,它可以是 null.
- Code: 对于租户唯一的层级字符串编码.
- DisplayName: 组织单元的显示名称.
### 组织树
- 由于组织单元可以有父级, 因此租户的所有组织单元是一个 树 结构. 这个树有一些规则;
- 可以有多个根级 (ParentId 是 null 的) .
- 一个组织单元的第一级子项数量有限制 (因为下面解释的固定的组织单元编码单位长度) .
### 组织单元编码
- 组织单元编码是通过 OrganizationUnitManager 服务自动生成和维护的. 它是一个字符串, 像这样:"00001.00042.00005"
- 通常用这种编码可以轻易地 (递归) 查询出数据库中组织单元的所有子项. 这个编码有一些规则 (当你使用 OrganizationUnitManager 时自动被应用的) :
- 对 租户 是 唯一的.
- 同一组织单元的全部子项都具有 以父级组织单元编码开头的 编码.
- 如示例中所示, 它是固定长度的且是基于树中组织单元的级别的.
- 尽管组织单元编码是唯一的, 但如果你移动了相关的组织单元, 它也可以被更改.
- 请注意, 你必须根据Id引用一个组织单元, 而不是编码, 因为编码后续是可以被更改的.
![](../../../img/uo.png)

2
docs/mkdocs.yml

@ -80,7 +80,7 @@ nav:
- 前端: user-guide/zh/infrastructure/frontend.md
- FreeSql: user-guide/zh/infrastructure/freesql.md
- 应用模块:
- 身份认证: user-guide/zh/modules/identity.md
- 基础模块: user-guide/zh/modules/basic.md
- 设置(Setting): user-guide/zh/modules/setting.md
- 数据字典: user-guide/zh/modules/dic.md
- 文件管理: user-guide/zh/modules/file.md

Loading…
Cancel
Save