写文档

jasonliaocn · May 7, 2020 · 782ff77 · 782ff77
1 parent f4a16ed
commit 782ff77
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 23 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -1,18 +1,47 @@
 module.exports = {
-    title: 'OpenAuth.Core',
-    description: '最好用的.net权限工作流框架,最好用的.net core vue前后分离框架'
+    title: 'OpenAuth.Core'
+    ,description: '最好用的.net权限工作流框架,最好用的.net core vue前后分离框架'
+    ,head: [
+      ['link', { rel: 'icon', href: '/logo.png' }]
+    ]
     ,themeConfig : {
       nav : [
+        { text: '首页', link: 'http://openauth.me/' , target:'_blank' },
           { text: 'OpenAuth.Core', link: '/core/' },
-          { text: 'OpenAuth.Net', link: '/net/' }
+          { text: 'OpenAuth.Net', link: '/net/' },
+          {
+            text: '项目地址',
+            ariaLabel: 'Proj Menu',
+            items: [
+              { text: 'gitee', link: 'https://gitee.com/yubaolee/OpenAuth.Core' , target:'_blank' },
+              { text: 'github', link: 'https://github.com/yubaolee/OpenAuth.Core' , target:'_blank' }
+            ]
+          }
       ],
       sidebar: {
         '/core/': [
           ['','项目介绍']
           ,"start"
-          ,"devnew"
-          ,"dataprivilege"
           ,"deploy" 
+          ,"devnew"
+          ,"identity" 
+          ,{
+            title: '权限控制',   // 必要的
+            path: 'dataprivilege',      // 可选的, 标题的跳转链接，应为绝对路径且必须存在
+            sidebarDepth: 1,    // 可选的, 默认值是 1
+            children: [
+              'dataprivilege'
+            ]
+          }
+          ,{
+            title: '工作流',   // 必要的
+            path: 'thirdparty',      // 可选的, 标题的跳转链接，应为绝对路径且必须存在
+            sidebarDepth: 1,    // 可选的, 默认值是 1
+            children: [
+              'thirdparty'
+            ]
+          }
+          ,"changelog" 
         ],
 
         '/net/': [

diff --git a/docs/.vuepress/public/configmvc.png b/docs/.vuepress/public/configmvc.png
diff --git a/docs/.vuepress/public/mvcmain.png b/docs/.vuepress/public/mvcmain.png
diff --git a/docs/.vuepress/public/startmvc.png b/docs/.vuepress/public/startmvc.png
diff --git a/docs/README.md b/docs/README.md
@@ -2,7 +2,7 @@
 home: true
 heroImage: /logo.png
 heroText: OpenAuth.Core
-tagline: 最好用的.net权限工作流框架,超酷的.net/vue前后端分离实践
+tagline: 最好用的.net权限工作流框架,最实用的.net/vue前后端分离方案
 actionText: 快速上手 →
 actionLink: /core/start/
 features:

diff --git a/docs/core/README.md b/docs/core/README.md
@@ -48,5 +48,20 @@ OpenAuth.Core是一个开源的权限工作流快速开发框架。框架基于M
 
 * 设计工具 PowerDesigner + Enterprise Architect
 
+## 开源版和企业版不同点
+
+|    开源版    | 高级/企业版           |
+| ------------- |:-------------:| 
+| 单站点Asp.Net Core Mvc方式     | 前后端完全分离的Asp.Net Core WebAPI + vue方式 | 
+| 基于最新版LayUI界面     | 基于最新版ElementUI界面  | 
+| 基于Quartz的定时任务控制    | 基于Quartz的定时任务控制，`且支持可视化CRON表达式设计`      |   
+| 基于leipiformdesign的动态表单设计   | 在开源版的基础上，`实现可拖拽的表单设计且独立成vue组件`      |   
+| 基于gooflow的流程设计   | 基于当今世界最流行的jsplumb开发的流程设计      |   
+| 灵活的数据权限控制   | 在开源版的基础上，`实现可视化的权限控制配置`   |   
+| 全部手工码字   | 提供基于CodeSmith的代码生成功能，可快速生成带有头/明细结构的页面   |   
+| --   | 提供数据库结构PowerDesigner设计文件  |   
+
+
+
 
 
diff --git a/docs/core/changelog.md b/docs/core/changelog.md
@@ -1,3 +1,5 @@
+# 更新日志
+
 `OpenAuth.Core 2.0`
 * 【新增】框架升级至.net core sdk 3.1.100
 

diff --git a/docs/core/deploy.md b/docs/core/deploy.md
@@ -1,21 +1,39 @@
-# 发布部署
+# 部署
 
-以控制台方式部署：
+::: tip
+因.net core内部有自托管的Web服务器，推荐使用控制台方式部署
+:::
 
-* 站点OpenAuth.Mvc部署：
+## 站点OpenAuth.Mvc部署
 
-直接在解决方案资源管理器中，选中OpenAuth.Mvc右键【发布】，出现下面的配置框，使用文件系统即可：
+* 修改部署环境的连接字符串信息,特别注意是`appsettings.Production.json`文件：
+![说明](/configmvc.png "说明")
+
+::: warning
+dotnet core的正式环境和测试环境的切换是通过环境变量ASPNETCORE_ENVIRONMENT来控制的。
+在centos切换成正式可以用
+```shell
+export ASPNETCORE_ENVIRONMENT=Production
+```
+在Widows系统中需要做相同的配置
+
+:::
+
+* 直接在解决方案资源管理器中，选中OpenAuth.Mvc右键【发布】，出现下面的配置框，使用文件系统即可：
 
 ![说明](http://pj.openauth.me/zentao/file-read-8.png "说明")
 
-发布完成后可以在输出目录看到发布详情（红色框内即为发布的文件夹）：
+* 发布完成后可以在输出目录看到发布详情（红色框内即为发布的文件夹）：
 
 ![说明](http://pj.openauth.me/zentao/file-read-69.png "说明")
 
-发布【OpenAuth.Mvc】完成后进入文件目录【netcoreapp2.1\publish】，直接使用`dotnet  openauth.mvc.dll` 命令启动。启动成功后使用浏览器打开http://localhost:1802 即可访问，如下图所示：
+* 发布【OpenAuth.Mvc】完成后进入文件目录【netcoreapp2.1\publish】，直接使用`dotnet  openauth.mvc.dll` 命令启动。启动成功后使用浏览器打开http://localhost:1802 即可访问，如下图所示：
+
+![说明](/mvcmain.png "说明")
+
 
-![说明](https://gitee.com/uploads/images/2018/0328/150659_6900820e_362401.png "说明")
+## 接口OpenAuth.WebApi部署
 
-* 接口OpenAuth.WebApi部署请查看[企业版](http://openauth.me/question/detail.html?id=a2be2d61-7fcb-4df8-8be2-9f296c22a89c)内部文档
+请查看[企业版](http://openauth.me/question/detail.html?id=a2be2d61-7fcb-4df8-8be2-9f296c22a89c)内部文档
 
 
diff --git a/docs/core/identity.md b/docs/core/identity.md
@@ -1,9 +1,11 @@
 
+# OAuth集成
+
 OpenAuth.core支持两种登录认证方式：自定义认证和基于IdentityServer的OAuth认证。
 
 这两种方式通过配置webapi或mvc的appsettings.json可以自由切换:
 
-```javascript
+```json
 "IdentityServerUrl": "http://localhost:12796", //IdentityServer服务器地址。如果为空，则不启用OAuth认证
 ```
 

diff --git a/docs/core/start.md b/docs/core/start.md
@@ -14,18 +14,22 @@
 
 ## 打开项目
 
-使用vs2017(推荐)打开 `OpenAuth.Core.sln`
+使用Visual Studio 2019或Rider打开 `OpenAuth.Core.sln`
+
+
 
 ## 修改连接字符串
 
 * 修改OpenAuth.Mvc/appsettings.json连接字符串，如下：
-```xml
+```json
  "OpenAuthDBContext": "Data Source=.;Initial Catalog=OpenAuthDB;User=sa;Password=000000"
+ "DbType": "SqlServer" //数据库类型：SqlServer、MySql
 ```
 
 * 修改OpenAuth.WebApi/appsettings.json连接字符串,如下：
-```xml
+```json
  "OpenAuthDBContext": "Data Source=.;Initial Catalog=OpenAuthDB;User=sa;Password=000000"
+ "DbType": "SqlServer" //数据库类型：SqlServer、MySql
 ```
 
 ## 编译运行
@@ -34,11 +38,7 @@
 `注：首次启动时，visual studio会启动nuget还原第三方依赖包，请保持网络通畅，并等待一段时间`
 
 启动openauth.mvc项目。
-![启动](http://demo.openauth.me:8887/upload_files/190110165027039.jpg "启动")
-
-## 更多文档
 
-如需更多文档请点击[这里](http://openauth.me/question/detail.html?id=a2be2d61-7fcb-4df8-8be2-9f296c22a89c)
+![启动](/startmvc.png "启动")
 
-![更多文档](http://119.84.146.233:8887/upload_files/190716002245221.jpg "更多文档")
 
diff --git a/docs/core/thirdparty.md b/docs/core/thirdparty.md
@@ -1,3 +1,5 @@
+# 三方对接
+
 1. 在OpenAuth中设计表单，注意表单中的控件名称，在步骤3调用OpenAuth创建流程实例接口时，frmData参数中的属性必须严格按该命名提交。
 
 ![](http://demo.openauth.me:8887/upload_files/190730144125614.jpg "表单设计说明")