docs: unified NG-ALAIN text mark (#1677)

ng-alain · Nov 1, 2023 · 491a342 · 491a342
1 parent d9ea22f
commit 491a342
Show file tree

Hide file tree

Showing 19 changed files with 27 additions and 19 deletions.
diff --git a/.github/workflows/deploy-site.yml b/.github/workflows/deploy-site.yml
@@ -16,7 +16,7 @@ jobs:
 
       - name: build
         run: |
-          yarn run site:build
+          yarn run site:build:ssr
           cp ./src/dist/browser/index.html ./src/dist/browser/404.html
           cp ./Dockerfile.docs ./src/dist/browser/Dockerfile.docs
           cp -r ./_nginx/ ./src/dist/browser/_nginx

diff --git a/.github/workflows/docker-build-doc-site.yml b/.github/workflows/docker-build-doc-site.yml
@@ -1,5 +1,6 @@
 name: docker-build-doc-site
 
+# on: push
 on:
   push:
     branches:

diff --git a/docs/contributing.zh-CN.md b/docs/contributing.zh-CN.md
@@ -38,7 +38,7 @@ type: Other
 
 ## Pull Request
 
-Ng Alain 会关注所有的 pull request，我们会 review 以及合并你的代码，也有可能要求你做一些修改或者告诉你我们为什么不能接受这样的修改。
+NG-ALAIN 会关注所有的 pull request，我们会 review 以及合并你的代码，也有可能要求你做一些修改或者告诉你我们为什么不能接受这样的修改。
 
 **在你发送 Pull Request 之前**，请确认你是按照下面的步骤来做的：
 

diff --git a/docs/server.en-US.md b/docs/server.en-US.md
@@ -11,10 +11,11 @@ Work in the form of the Restful API with the server application of any technolog
 In NG-ALAIN, a complete front-end UI interaction to the server-side processing flow looks like this:
 
 1. Start Angular for the first time to execute `APP_INITIALIZER`;
+  - Usually some APP general data is loaded before startup, such as currently authorized user data, menu data, dictionary data, configuration data, etc.
 2. UI component interaction;
 3. Send the request using the encapsulated [_HttpClient](/theme/http);
 4. Trigger the user authentication interceptor [@delon/auth](/auth/getting-started) and add the `token` parameter uniformly;
-    - If there is no `token` or an expired interrupt subsequent request, jump directly to the login page;
+  - If there is no `token` or an expired interrupt subsequent request, jump directly to the login page;
 5. Trigger the default interceptor to process the prefix and other information;
 6. Get the server back;
 7. Trigger the default interceptor to handle request exceptions, business exceptions, etc.

diff --git a/docs/server.zh-CN.md b/docs/server.zh-CN.md
@@ -12,6 +12,7 @@ NG-ALAIN 是一套基于 Angular 技术栈的单页面应用，我们提供的
 在 NG-ALAIN 中，一个完整的前端 UI 交互到服务端处理流程是这样的：
 
 1. 首次启动 Angular 执行 `APP_INITIALIZER`；
+  - 通常会在启动前先加载一些APP通用数据，例如：当前已授权用户数据、菜单数据、字典数据、配置项等
 2. UI 组件交互操作；
 3. 使用封装的 [_HttpClient](/theme/http) 发送请求；
 4. 触发用户认证拦截器 [@delon/auth](/auth/getting-started)，统一加入 `token` 参数；

diff --git a/schematics/README.md b/schematics/README.md
@@ -4,7 +4,7 @@ Angular CLI Schematics of ng-alain.
 
 # ng-alain
 
-[Ng-zorro-antd](https://github.com/NG-ZORRO/ng-zorro-antd) admin panel front-end framework.
+[NG-ZORRO](https://github.com/NG-ZORRO/ng-zorro-antd) admin panel front-end framework.
 
 ## Links
 

diff --git a/schematics/application/files/src/app/core/startup/startup.service.ts b/schematics/application/files/src/app/core/startup/startup.service.ts
@@ -61,6 +61,8 @@ export class StartupService {
     }
   <% } else { %>
     private viaHttp(): Observable<void> {
+      // If http request allows anonymous access, you need to add `ALLOW_ANONYMOUS`:
+      // this.httpClient.get('assets/tmp/app-data.json', { context: new HttpContext().set(ALLOW_ANONYMOUS, true) })
       return this.httpClient.get('assets/tmp/app-data.json').pipe(
         catchError((res: NzSafeAny) => {
           console.warn(`StartupService.load: Network request failed`, res);
@@ -103,8 +105,8 @@ export class StartupService {
     // }
     // mock
     const app: any = {
-      name: `ng-alain`,
-      description: `Ng-zorro admin panel front-end framework`
+      name: `NG-ALAIN`,
+      description: `NG-ZORRO admin panel front-end framework`
     };
     const user: any = {
       name: 'Admin',

diff --git a/schematics/application/schema.json b/schematics/application/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainShell",
-  "title": "Ng Alain Shell Options Schema",
+  "title": "NG-ALAIN Shell Options Schema",
   "type": "object",
   "properties": {
     "codeStyle": {

diff --git a/schematics/curd/schema.json b/schematics/curd/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainCURDComponent",
-  "title": "Ng Alain CURD Component Options Schema",
+  "title": "NG-ALAIN CURD Component Options Schema",
   "type": "object",
   "properties": {
     "path": {

diff --git a/schematics/edit/schema.json b/schematics/edit/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainEditComponent",
-  "title": "Ng Alain Edit Component Options Schema",
+  "title": "NG-ALAIN Edit Component Options Schema",
   "type": "object",
   "additionalProperties": true,
   "properties": {

diff --git a/schematics/empty/schema.json b/schematics/empty/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainEmptyComponent",
-  "title": "Ng Alain Empty Component Options Schema",
+  "title": "NG-ALAIN Empty Component Options Schema",
   "type": "object",
   "additionalProperties": true,
   "properties": {

diff --git a/schematics/list/schema.json b/schematics/list/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainListComponent",
-  "title": "Ng Alain List Component Options Schema",
+  "title": "NG-ALAIN List Component Options Schema",
   "type": "object",
   "additionalProperties": true,
   "properties": {

diff --git a/schematics/module/schema.json b/schematics/module/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainModule",
-  "title": "Ng Alain Module Options Schema",
+  "title": "NG-ALAIN Module Options Schema",
   "type": "object",
   "properties": {
     "name": {

diff --git a/schematics/sta/schema.json b/schematics/sta/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainSTAComponent",
-  "title": "Ng Alain Swagger To API Options Schema",
+  "title": "NG-ALAIN Swagger To API Options Schema",
   "type": "object",
   "additionalProperties": true,
   "properties": {

diff --git a/schematics/tpl/schema.json b/schematics/tpl/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainTplComponent",
-  "title": "Ng Alain Tpl Options Schema",
+  "title": "NG-ALAIN Tpl Options Schema",
   "type": "object",
   "additionalProperties": true,
   "properties": {

diff --git a/schematics/view/schema.json b/schematics/view/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "SchematicsNgAlainViewComponent",
-  "title": "Ng Alain View Component Options Schema",
+  "title": "NG-ALAIN View Component Options Schema",
   "type": "object",
   "additionalProperties": true,
   "properties": {

diff --git a/src/app/core/meta.service.ts b/src/app/core/meta.service.ts
@@ -202,11 +202,14 @@ export class MetaService {
   }
 
   getPathByUrl(url: string): any {
-    url = url.split('=')[0].split('?')[0];
+    url = url
+      .split('=')[0]
+      .split('?')[0]
+      .replace(/\/(en|zh)$/, '/');
     let ret: any;
     (this._menus || []).forEach((cat: any) => {
       if (ret) return;
-      ret = cat.list.find((i: any) => i.url === url);
+      ret = cat.list.find((i: { url: string }) => i.url.startsWith(url));
     });
     return ret;
   }

diff --git a/src/app/core/startup.service.ts b/src/app/core/startup.service.ts
@@ -27,7 +27,7 @@ export class StartupService {
       if (slowEl) {
         slowEl.remove();
       }
-      this.injector.get(TitleService).suffix = 'Ng Alain';
+      this.injector.get(TitleService).suffix = 'NG-ALAIN';
       if (this.platform.isBrowser) {
         setTimeout(() => this.lazyLoad(), 100);
       }

diff --git a/src/index.html b/src/index.html
@@ -3,7 +3,7 @@
 
 <head>
   <meta charset="utf-8">
-  <title>Ng Alain - 一个基于 Antd 中后台前端解决方案</title>
+  <title>NG-ALAIN - 一个基于 Antd 中后台前端解决方案</title>
   <base href="/">
   <meta name="viewport" content="width=device-width,initial-scale=1,user-scalable=0">
   <link rel="preconnect" href="https://gw.alipayobjects.com" crossorigin="anonymous">