Re-organized the docs navigation menu

5 years ago · fe25fe2b16
parent a133314b2f
commit fe25fe2b16
12 changed files with 324 additions and 240 deletions
--- a/docs/zh-Hans/Authentication/Social-External-Logins.md
+++ b/docs/zh-Hans/Authentication/Social-External-Logins.md
@ -1,33 +1,3 @@
 # 社交/外部登录

-
-[帐户模块](../Modules/Account.md)已配置为开箱即用的处理社交或外部登录. 你可以按照ASP.NET Core文档向你的应用程序添加社交/外部登录提供程序.
-
-## 示例: Facebook 认证
-
-按照[ASP.NET Core Facebook集成文档](https://docs.microsoft.com/zh-cn/aspnet/core/security/authentication/social/facebook-logins)向你应用程序添加Facebook登录.
-
-#### 添加NuGet包
-
-添加[Microsoft.AspNetCore.Authentication.Facebook]包到你的项目. 基于你的架构,可能是 `.Web`,`.IdentityServer`(对于分层启动)或 `.Host` 项目.
-
-#### 配置提供程序
-
-在你模块的 `ConfigureServices` 方法中使用 `.AddFacebook(...)` 扩展方法来配置客户端:
-
-````csharp
-context.Services.AddAuthentication()
-    .AddFacebook(facebook =>
-    {
-        facebook.AppId = "...";
-        facebook.AppSecret = "...";
-        facebook.Scope.Add("email");
-        facebook.Scope.Add("public_profile");
-    });
-````
-
-> 最佳实践是使用 `appsettings.json` 或ASP.NET Core用户机密系统来存储你的凭据,而不是像这样硬编码值. 请参阅[微软](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/social/facebook-logins)文档了解如何使用用户机密.
-
-## Angular UI
-
-从v3.1开始,Angular UI使用授权码流程(作为最佳实践)通过重定向到MVC UI登录页面来对用户进行身份验证. 因此,即使你使用的是Angular UI,社交/外部登录集成也与上面说明的相同.并且可以开箱即用.
+> 文档已经移动其他位置. 参阅[账户模块](../Modules/Account.md)文档.
--- a/docs/zh-Hans/Data-Access.md
+++ b/docs/zh-Hans/Data-Access.md
@ -8,4 +8,8 @@ ABP框架被设计为与数据库无关, 它通过[仓储](Repositories.md)和[
 * [MongoDB](MongoDB.md)
 * [Dapper](Dapper.md)

-在以后的版本中可能会添加更多的提供程序.
+## 另请参阅
+
+* [连接字符串](Connection-Strings.md)
+* [种子数据](Data-Seeding.md)
+* [数据过滤](Data-Filtering.md)
--- a/docs/zh-Hans/Modules/Account.md
+++ b/docs/zh-Hans/Modules/Account.md
@ -0,0 +1,36 @@
+# 账户模块
+
+该模块提供必要的UI页面与组件使用户登录和注册到应用程序.
+
+> 文档正在更新
+
+## 社交/外部登录
+
+### 示例: Facebook 认证
+
+按照[ASP.NET Core Facebook集成文档](https://docs.microsoft.com/zh-cn/aspnet/core/security/authentication/social/facebook-logins)向你应用程序添加Facebook登录.
+
+#### 添加NuGet包
+
+添加[Microsoft.AspNetCore.Authentication.Facebook]包到你的项目. 基于你的架构,可能是 `.Web`,`.IdentityServer`(对于分层启动)或 `.Host` 项目.
+
+#### 配置提供程序
+
+在你模块的 `ConfigureServices` 方法中使用 `.AddFacebook(...)` 扩展方法来配置客户端:
+
+````csharp
+context.Services.AddAuthentication()
+    .AddFacebook(facebook =>
+    {
+        facebook.AppId = "...";
+        facebook.AppSecret = "...";
+        facebook.Scope.Add("email");
+        facebook.Scope.Add("public_profile");
+    });
+````
+
+> 最佳实践是使用 `appsettings.json` 或ASP.NET Core用户机密系统来存储你的凭据,而不是像这样硬编码值. 请参阅[微软](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/social/facebook-logins)文档了解如何使用用户机密.
+
+### Angular UI
+
+从v3.1开始,Angular UI使用授权码流程(作为最佳实践)通过重定向到MVC UI登录页面来对用户进行身份验证. 因此,即使你使用的是Angular UI,社交/外部登录集成也与上面说明的相同.并且可以开箱即用.
--- a/docs/zh-Hans/Modules/Blogging.md
+++ b/docs/zh-Hans/Modules/Blogging.md
@ -0,0 +1 @@
+TODO...
--- a/docs/zh-Hans/Modules/Client-Simulation.md
+++ b/docs/zh-Hans/Modules/Client-Simulation.md
@ -0,0 +1,3 @@
+# Client Simulation Module
+
+TODO
--- a/docs/zh-Hans/Modules/Cms-Kit.md
+++ b/docs/zh-Hans/Modules/Cms-Kit.md
@ -0,0 +1,3 @@
+# CMS Kit Module
+
+TODO
--- a/docs/zh-Hans/Modules/Feature-Management.md
+++ b/docs/zh-Hans/Modules/Feature-Management.md
@ -0,0 +1 @@
+TODO...
--- a/docs/zh-Hans/Modules/Identity.md
+++ b/docs/zh-Hans/Modules/Identity.md
@ -2,7 +2,7 @@

 身份模块基于Microsoft Identity库用于管理[组织单元](Organization-Units.md), 角色, 用户和他们的权限.

-参阅 [源码](https://github.com/abpframework/abp/tree/dev/modules/identity). 文档很快会被完善.
+> 参阅 [源码](https://github.com/abpframework/abp/tree/dev/modules/identity). 文档很快会被完善.

 ## Identity安全日志

--- a/docs/zh-Hans/Modules/IdentityServer.md
+++ b/docs/zh-Hans/Modules/IdentityServer.md
@ -0,0 +1 @@
+TODO...
--- a/docs/zh-Hans/Modules/Index.md
+++ b/docs/zh-Hans/Modules/Index.md
@ -1,6 +1,6 @@
 # 应用程序模块

-ABP是一个 **模块化的应用程序框架** 由十多个 **nuget packages** 组成. 它提供了一个完整的基础设施来构建你自己的应用程序模块,这些模块包含实体,服务,数据库集成,API,UI组件等.
+ABP是一个 **模块化的应用程序框架** 由十多个 **NuGet & NPM packages** 组成. 它提供了一个完整的基础设施来构建你自己的应用程序模块,这些模块包含实体,服务,数据库集成,API,UI组件等.

 **有两种类型的模块.** 它们没有任何结构上的差异,只是按照功能和目地分类:

@ -9,20 +9,20 @@ ABP是一个 **模块化的应用程序框架** 由十多个 **nuget packages**

 ## 开源的应用程序模块

-有一些由ABP社区开发和维护的 **开源免费** 的应用程序模块:
+有一些由ABP框架开发和维护的 **开源免费** 的应用程序模块:

-* **Account**: 提供账户管理UI,并允许用户登录/注册应用程序.
+* [**Account**](Account.md): 提供账户管理UI,并允许用户登录/注册应用程序.
 * [**Audit Logging**](Audit-Logging.md): 用于将审计日志持久化到数据库.
-* **Background Jobs**: 用于在使用默认后台作业管理器时保存后台作业.
-* **Blogging**: 用于创建精美的博客. ABP的[博客](https://blog.abp.io/) 就使用了此模块.
+* [**Background Jobs**](Background-Jobs.md): 用于在使用默认后台作业管理器时保存后台作业.
+* [**Blogging**](Blogging.md): 用于创建精美的博客. ABP的[博客](https://blog.abp.io/) 就使用了此模块.
 * [**Docs**](Docs.md): 用于创建技术文档页面. ABP的[文档](https://abp.io/documents/) 就使用了此模块.
-* **Feature Management**: 用于保存和管理功能.
+* [**Feature Management**](Feature-Management.md): 用于保存和管理功能.
 * [**Identity**](Identity.md): 基于Microsoft Identity管理组织单元,角色,用户和他们的权限.
-* **Identity Server**: 集成了IdentityServer4.
-* **Permission Management**: 用于保存权限.
-* **Setting Management**: 用于保存设置.
-* **Tenant Management**: 管理[多租户](../Multi-Tenancy.md)应用程序的租户.
-* **Users**: 抽象用户, 因此其他模块可以依赖此模块而不是Identity模块.
+* [**Identity Server**](IdentityServer.md): 集成了IdentityServer4.
+* [**Permission Management**](Permission-Management.md): 用于保存权限.
+* [**Setting Management**](Setting-Management.md): 用于保存设置.
+* [**Tenant Management**](Tenant-Management.md): 管理[多租户](../Multi-Tenancy.md)应用程序的租户.
+* [**Users**](Users.md): 抽象用户, 因此其他模块可以依赖此模块而不是Identity模块.
 * [**Virtual File Explorer**](Virtual-File-Explorer.md): 提供简单的UI查看[虚拟文件系统](../Virtual-File-System.md)中的文件.

 模块化文档正在编写中. 请参阅[这个仓库](https://github.com/abpframework/abp/tree/master/modules)获取所有模块的源代码.
--- a/docs/zh-Hans/Modules/Users.md
+++ b/docs/zh-Hans/Modules/Users.md
@ -0,0 +1 @@
+TODO...
--- a/docs/zh-Hans/docs-nav.json
+++ b/docs/zh-Hans/docs-nav.json
@ -21,9 +21,33 @@
        }
      ]
    },
+    {
+      "text": "启动模板",
+      "items": [
+        {
+          "text": "概述",
+          "path": "Startup-Templates/Index.md"
+        },
+        {
+          "text": "应用程序",
+          "path": "Startup-Templates/Application.md"
+        },
+        {
+          "text": "模块",
+          "path": "Startup-Templates/Module.md"
+        },
+        {
+          "text": "控制台",
+          "path": "Startup-Templates/Console.md"
+        },
+        {
+          "text": "WPF",
+          "path": "Startup-Templates/WPF.md"
+        }
+      ]
+    },
    {
      "text": "教程",
-      "path": "Tutorials/Index.md",
      "items": [
        {
          "text": "应用开发",
@ -41,29 +65,10 @@
              "path": "Tutorials/Part-3.md"
            }
          ]
-        }
-      ]
-    },
-    {
-      "text": "指南",
-      "items": [
+        },
        {
-          "text": "自定义应用模块",
-          "path": "Customizing-Application-Modules-Guide.md",
-          "items": [
-            {
-              "text": "扩展实体",
-              "path": "Customizing-Application-Modules-Extending-Entities.md"
-            },
-            {
-              "text": "重写服务",
-              "path": "Customizing-Application-Modules-Overriding-Services.md"
-            },
-            {
-              "text": "重写用户界面",
-              "path": "Customizing-Application-Modules-Overriding-User-Interface.md"
-            }
-          ]
+          "text": "社区文章",
+          "path": "https://community.abp.io/articles"
        },
        {
          "text": "从ASP.NET Boilerplate迁移",
@ -71,19 +76,6 @@
        }
      ]
    },
-    {
-      "text": "CLI",
-      "path": "CLI.md"
-    },
-    {
-      "text": "认证",
-      "items": [
-        {
-          "text": "社交/外部登录",
-          "path": "Authentication/Social-External-Logins.md"
-        }
-      ]
-    },
    {
      "text": "基础知识",
      "items": [
@ -105,10 +97,6 @@
            }
          ]
        },
-        {
-          "text": "虚拟文件系统",
-          "path": "Virtual-File-System.md"
-        },
        {
          "text": "本地化",
          "path": "Localization.md"
@ -139,17 +127,13 @@
          "text": "日志",
          "path": "Logging.md"
        },
-        {
-          "text": "审计日志",
-          "path": "Audit-Logging.md"
-        },
        {
          "text": "设置管理",
          "path": "Settings.md"
        },
        {
-          "text": "数据过滤",
-          "path": "Data-Filtering.md"
+          "text": "连接字符串",
+          "path": "Connection-Strings.md"
        },
        {
          "text": "对象扩展",
@ -158,39 +142,88 @@
      ]
    },
    {
-      "text": "事件总线",
-      "items": [
+      "text": "基础设施",
+      "items":[
        {
-          "text": "概述",
-          "path": "Event-Bus.md"
-        },
-        {
-          "text": "本地 Event Bus",
-          "path": "Local-Event-Bus.md"
+          "text": "后台服务",
+          "items": [
+            {
+              "text": "后台作业",
+              "path": "Background-Jobs.md",
+              "items": [
+                {
+                  "text": "Hangfire 集成",
+                  "path": "Background-Jobs-Hangfire.md"
+                },
+                {
+                  "text": "RabbitMQ 集成",
+                  "path": "Background-Jobs-RabbitMq.md"
+                },
+                {
+                  "text": "Quartz 集成",
+                  "path": "Background-Jobs-Quartz.md"
+                }
+              ]
+            },
+            {
+              "text": "后台工作者",
+              "path": "Background-Workers.md",
+              "items": [
+                {
+                  "text": "Quartz 集成",
+                  "path": "Background-Workers-Quartz.md"
+                }
+              ]
+            }
+          ]
        },
        {
-          "text": "分布式 Event Bus",
-          "path": "Distributed-Event-Bus.md",
+          "text": "事件总线",
          "items": [
            {
-              "text": "RabbitMQ 集成",
-              "path": "Distributed-Event-Bus-RabbitMQ-Integration.md"
+              "text": "概述",
+              "path": "Event-Bus.md"
            },
            {
-              "text": "Kafka 集成",
-              "path": "Distributed-Event-Bus-Kafka-Integration.md"
+              "text": "本地 Event Bus",
+              "path": "Local-Event-Bus.md"
            },
            {
-              "text": "Rebus 集成",
-              "path": "Distributed-Event-Bus-Rebus-Integration.md"
+              "text": "分布式 Event Bus",
+              "path": "Distributed-Event-Bus.md",
+              "items": [
+                {
+                  "text": "RabbitMQ 集成",
+                  "path": "Distributed-Event-Bus-RabbitMQ-Integration.md"
+                },
+                {
+                  "text": "Kafka 集成",
+                  "path": "Distributed-Event-Bus-Kafka-Integration.md"
+                },
+                {
+                  "text": "Rebus 集成",
+                  "path": "Distributed-Event-Bus-Rebus-Integration.md"
+                }
+              ]
            }
          ]
-        }
-      ]
-    },
-    {
-      "text": "服务",
-      "items": [
+        },
+        {
+          "text": "种子数据",
+          "path": "Data-Seeding.md"
+        },
+        {
+          "text": "虚拟文件系统",
+          "path": "Virtual-File-System.md"
+        },
+        {
+          "text": "审计日志",
+          "path": "Audit-Logging.md"
+        },
+        {
+          "text": "数据过滤",
+          "path": "Data-Filtering.md"
+        },
        {
          "text": "当前用户",
          "path": "CurrentUser.md"
@ -270,22 +303,41 @@
      ]
    },
    {
-      "text": "多租户",
-      "path": "Multi-Tenancy.md"
-    },
-    {
-      "text": "模块开发",
-      "items": [
-        {
-          "text": "基础",
-          "path": "Module-Development-Basics.md"
-        },
+      "text": "架构",
+      "items":[
        {
-          "text": "模块插件"
-        },
-        {
-          "text": "最佳实践",
-          "path": "Best-Practices/Index.md"
+          "text": "模块化",
+          "items": [
+            {
+              "text": "基础",
+              "path": "Module-Development-Basics.md"
+            },
+            {
+              "text": "模块插件"
+            },
+            {
+              "text": "自定义应用模块",
+              "path": "Customizing-Application-Modules-Guide.md",
+              "items": [
+                {
+                  "text": "扩展实体",
+                  "path": "Customizing-Application-Modules-Extending-Entities.md"
+                },
+                {
+                  "text": "重写服务",
+                  "path": "Customizing-Application-Modules-Overriding-Services.md"
+                },
+                {
+                  "text": "重写用户界面",
+                  "path": "Customizing-Application-Modules-Overriding-User-Interface.md"
+                }
+              ]
+            },
+            {
+              "text": "最佳实践",
+              "path": "Best-Practices/Index.md"
+            }
+          ]
        }
      ]
    },
@ -335,6 +387,14 @@
              "path": "Unit-Of-Work.md"
            }
          ]
+        },
+        {
+          "text": "多租户",
+          "path": "Multi-Tenancy.md"
+        },    
+        {
+          "text": "微服务架构",
+          "path": "Microservice-Architecture.md"
        }
      ]
    },
@ -516,58 +576,45 @@
          "path": "Data-Access.md"
        },
        {
-          "text": "连接字符串",
-          "path": "Connection-Strings.md"
-        },
-        {
-          "text": "数据库提供程序",
+          "text": "Entity Framework Core",
+          "path": "Entity-Framework-Core.md",
          "items": [
            {
-              "text": "Entity Framework Core",
-              "path": "Entity-Framework-Core.md",
-              "items": [
+              "text": "数据库迁移",
+              "path": "Entity-Framework-Core-Migrations.md"
+            },
+            {
+              
+              "text": "切换DMBS",
+              "path": "Entity-Framework-Core-Other-DBMS.md",
+              "items":[
                {
-                  "text": "数据库迁移",
-                  "path": "Entity-Framework-Core-Migrations.md"
+                  "text": "到MySql",
+                  "path": "Entity-Framework-Core-MySQL.md"
                },
                {
-                  
-                  "text": "切换DMBS",
-                  "path": "Entity-Framework-Core-Other-DBMS.md",
-                  "items":[
-                    {
-                      "text": "到MySql",
-                      "path": "Entity-Framework-Core-MySQL.md"
-                    },
-                    {
-                      "text": "到PostgreSQL",
-                      "path": "Entity-Framework-Core-PostgreSQL.md"
-                    },
-                    {
-                      "text": " Oracle",
-                      "path": "Entity-Framework-Core-Oracle.md"
-                    },
-                    {
-                      "text": "到SQLite",
-                      "path": "Entity-Framework-Core-SQLite.md"
-                    }
-                  ]
+                  "text": "到PostgreSQL",
+                  "path": "Entity-Framework-Core-PostgreSQL.md"
+                },
+                {
+                  "text": " Oracle",
+                  "path": "Entity-Framework-Core-Oracle.md"
+                },
+                {
+                  "text": "到SQLite",
+                  "path": "Entity-Framework-Core-SQLite.md"
                }
              ]
-            },
-            {
-              "text": "MongoDB",
-              "path": "MongoDB.md"
-            },
-            {
-              "text": "Dapper",
-              "path": "Dapper.md"
            }
          ]
        },
        {
-          "text": "种子数据",
-          "path": "Data-Seeding.md"
+          "text": "MongoDB",
+          "path": "MongoDB.md"
+        },
+        {
+          "text": "Dapper",
+          "path": "Dapper.md"
        }
      ]
    },
@ -581,111 +628,128 @@
      ]
    },
    {
-      "text": "后台服务",
+      "text": "示例",
      "items": [
        {
-          "text": "后台作业",
-          "path": "Background-Jobs.md",
-          "items": [
-            {
-              "text": "Hangfire 集成",
-              "path": "Background-Jobs-Hangfire.md"
-            },
-            {
-              "text": "RabbitMQ 集成",
-              "path": "Background-Jobs-RabbitMq.md"
-            },
-            {
-              "text": "Quartz 集成",
-              "path": "Background-Jobs-Quartz.md"
-            }
-          ]
+          "text": "所有示例",
+          "path": "Samples/Index.md"
        },
        {
-          "text": "后台工作者",
-          "path": "Background-Workers.md",
-          "items": [
-            {
-              "text": "Quartz 集成",
-              "path": "Background-Workers-Quartz.md"
-            }
-          ]
+          "text": "微服务示例",
+          "path": "Samples/Microservice-Demo.md"
        }
      ]
-    },
+    },  
    {
-      "text": "启动模板",
-      "items": [
+      "text": "应用模块",
+      "items":[
        {
          "text": "概述",
-          "path": "Startup-Templates/Index.md"
+          "path": "Modules/Index.md"
        },
        {
-          "text": "应用程序",
-          "path": "Startup-Templates/Application.md"
+          "text": "账户",
+          "path": "Modules/Account.md"
        },
        {
-          "text": "模块",
-          "path": "Startup-Templates/Module.md"
+          "text": "审计日志",
+          "path": "Modules/Audit-Logging.md"
        },
        {
-          "text": "控制台",
-          "path": "Startup-Templates/Console.md"
+          "text": "后台作业",
+          "path": "Modules/Background-Jobs.md"
        },
        {
-          "text": "WPF",
-          "path": "Startup-Templates/WPF.md"
+          "text": "博客",
+          "path": "Modules/Blogging.md"
+        },
+        {
+          "text": "客户端模拟",
+          "path": "Modules/Client-Simulation.md"
+        },
+        {
+          "text": "CMS Kit",
+          "path": "Modules/Cms-Kit.md"
+        },
+        {
+          "text": "文档",
+          "path": "Modules/Docs.md"
+        },
+        {
+          "text": "功能管理",
+          "path": "Modules/Feature-Management.md"
+        },
+        {
+          "text": "Identity",
+          "path": "Modules/Identity.md"
+        },
+        {
+          "text": "IdentityServer",
+          "path": "Modules/IdentityServer.md"
+        },
+        {
+          "text": "权限管理",
+          "path": "Modules/Permission-Management.md"
+        },
+        {
+          "text": "设置管理",
+          "path": "Modules/Setting-Management.md"
+        },
+        {
+          "text": "租户管理",
+          "path": "Modules/Tenant-Management.md"
+        },
+        {
+          "text": "用户",
+          "path": "Modules/Users.md"
+        },
+        {
+          "text": "虚拟文件浏览器",
+          "path": "Modules/Virtual-File-Explorer.md"
        }
      ]
    },
    {
-      "text": "示例",
+      "text": "发布信息",
      "items": [
        {
-          "text": "所有示例",
-          "path": "Samples/Index.md"
+          "text": "升级",
+          "path": "Upgrading.md"
        },
        {
-          "text": "微服务示例",
-          "path": "Samples/Microservice-Demo.md"
+          "text": "官方包",
+          "path": "https://abp.io/packages"
+        },
+        {
+          "text": "预览版本",
+          "path": "Previews.md"
+        },
+        {
+          "text": "每日构建",
+          "path": "Nightly-Builds.md"
+        },    
+        {
+          "text": "路线图",
+          "path": "Road-Map.md"
        }
      ]
    },
    {
-      "text": "应用模块",
-      "path": "Modules/Index.md"
-    },
-    {
-      "text": "微服务架构",
-      "path": "Microservice-Architecture.md"
-    },
-    {
-      "text": "预览版本",
-      "path": "Previews.md"
-    },
-    {
-      "text": "每日构建",
-      "path": "Nightly-Builds.md"
-    },
-    {
-      "text": "路线图",
-      "path": "Road-Map.md"
-    },
-    {
-      "text": "升级",
-      "path": "Upgrading.md"
+      "text": "参考",
+      "items": [
+        {
+          "text": "CLI",
+          "path": "CLI.md"
+        },
+        {
+          "text": "API文档",
+          "path": "{ApiDocumentationUrl}"
+        }
+      ]
    },
    {
      "text": "贡献指南",
      "path": "Contribution/Index.md"
-    },
-    {
-      "text": "API文档",
-      "path": "{ApiDocumentationUrl}"
-    },
-    {
-      "text": "官方包",
-      "path": "https://abp.io/packages"
    }
  ]
 }