update

docs/.vuepress/config.js

@@ -2,11 +2,11 @@ const path = require("path");
 const { config, themeConfig } = require("vuepress-theme-hope");
 
 module.exports = config({
-  title: "随心装技术文档",
+  title: "spug devOps 发布平台技术文档平台",
   theme: "vuepress-theme-hope",
-  description: "随心装技术文档, 包括2d,3d,硬装部分的详细说明",
+  description: "spug devOps 发布平台与项目接入规范",
   markdown: {
-    lineNumbers: true // 代码块显示行号
+    lineNumbers: true, // 代码块显示行号
   },
   smoothScroll: true,
   port: 5000,
@@ -16,7 +16,7 @@ module.exports = config({
   head: [
     // react 需要 React, ReactDOM 和 Babel 库
     // vue 只需要 vue 库
-    ["script", { src: "https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js" }]
+    ["script", { src: "https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js" }],
   ],
   // plugins: {
   //   "@vuepress/medium-zoom": {
@@ -40,7 +40,7 @@ module.exports = config({
       mermaid: true,
       demo: true,
       align: true,
-      mark: true
+      mark: true,
     },
     lastUpdated: "上次更新",
     // repo: "JackRay-c/vuepress-theme-note",
@@ -58,52 +58,52 @@ module.exports = config({
     // },
     nav: [
       { text: "基础架构", link: "/base/" },
-      { text: "组件", link: "/component/" },
-      { text: "Event", link: "/event/" },
-      { text: "2D", link: "/2d/" },
-      { text: "3D", link: "/3d/" },
-      { text: "硬装部分", link: "/hardfix/" }
+      // { text: "组件", link: "/component/" },
+      // { text: "Event", link: "/event/" },
+      // { text: "2D", link: "/2d/" },
+      // { text: "3D", link: "/3d/" },
+      // { text: "硬装部分", link: "/hardfix/" }
     ],
     sidebar: {
-      "/base/": [
-        {
-          title: "基础架构", // 必要的
-          collapsable: false, // 可选的, 默认值是 true,建议改为false
-          sidebarDepth: 1, // 可选的, 默认值是 1，建议改为0
-          children: ["", "develop"]
-        }
-      ],
-      "/component/": [
-        {
-          title: "components(组件)",
-          collapsable: false,
-          sidebarDepth: 1,
-          children: ["", "basic", "shared"]
-        }
-      ],
-      "/event/": [
-        {
-          title: "事件", // 必要的
-          collapsable: false, // 可选的, 默认值是 true,建议改为false
-          sidebarDepth: 0, // 可选的, 默认值是 1，建议改为0
-          children: ["inspect","boxstool", "switchView", "moveCanvas"]
-        }
-      ],
-      "/hardfix/": [
-        {
-          title: "目录", // 必要的
-          collapsable: false, // 可选的, 默认值是 true,建议改为false
-          sidebarDepth: 0, // 可选的, 默认值是 1，建议改为0
-          children: ["", "open"]
-        }
-      ]
-    }
+      // "/base/": [
+      //   {
+      //     title: "基础架构", // 必要的
+      //     collapsable: false, // 可选的, 默认值是 true,建议改为false
+      //     sidebarDepth: 1, // 可选的, 默认值是 1，建议改为0
+      //     children: ["", "develop"]
+      //   }
+      // ],
+      // "/component/": [
+      //   {
+      //     title: "components(组件)",
+      //     collapsable: false,
+      //     sidebarDepth: 1,
+      //     children: ["", "basic", "shared"]
+      //   }
+      // ],
+      // "/event/": [
+      //   {
+      //     title: "事件", // 必要的
+      //     collapsable: false, // 可选的, 默认值是 true,建议改为false
+      //     sidebarDepth: 0, // 可选的, 默认值是 1，建议改为0
+      //     children: ["inspect","boxstool", "switchView", "moveCanvas"]
+      //   }
+      // ],
+      // "/hardfix/": [
+      //   {
+      //     title: "目录", // 必要的
+      //     collapsable: false, // 可选的, 默认值是 true,建议改为false
+      //     sidebarDepth: 0, // 可选的, 默认值是 1，建议改为0
+      //     children: ["", "open"]
+      //   }
+      // ]
+    },
   },
   configureWebpack: {
     resolve: {
       alias: {
-        "@": path.join(__dirname, "../../src/")
-      }
-    }
-  }
+        "@": path.join(__dirname, "../../src/"),
+      },
+    },
+  },
 });

docs/README.md

@@ -1,67 +1,54 @@
 ---
 home: true
-heroImage: ''
+heroImage: ""
 actionText:
 actionLink: /zh/guide/
 
 features:
-  - title: 基本架构和开发说明
-    details: 主要关于项目情况和开发注意事项
-    link: /base
+  - title: 开发规范
+    details: 主要关于开发人员分支与测试人员关于开发分支约束
+    link: /branch
 
-  - title: 组件说明文档
-    details: 主要基本组件,共胜组件,以及custom的组件使用说明
-    link: /component
+  - title: 测试上线流程规范
+    details: 主要关于与业务,测试约束
+    link: /flow
 
-  - title: 事件Event 开发说明文档
-    details: 主要是公共事件Event,2d特供事件Event,3d特供事件Event的技术细则
-    link: /event
+  - title: 运维与日常技术支持规范
+    details: 主要平台运维, 值班, 报警, 预警, 容灾等行为规范
+    link: /support
 
-  - title: 2D canvas开发说明文档
-    details: 主要是canvas和业务使用说明
-    link: /2d
+footer: MIT Licensed | Copyright © 2019-present
+---
 
-  - title: 3D 开发说明文档
-    details: 主要是3D,webgl等和业务使用说明
-    link: /3d
+# 正式发布流程 (审核)
 
-  - title: 硬装 开发说明文档
-    details: 主要是硬装部分等和业务使用说明
-    link: /3d
+```mermaid
 
-footer: MIT Licensed | Copyright © 2019-present
----
 
-# 项目地址:
+graph TD
+   A[开发人员] --按分支规范提交代码 --> B[/测试人员\]--申请上线 --> C[测试审核主管]--审核通过-->B --自动发布 --> D[spug devOps平台] 
 
-::: tip Gogs
+   B[测试人员] --反馈上线问题--> F[运维人员] --技术支持--> B[测试人员]
 
-http://192.168.0.115:3000/4dkankan/4dkankan_floorplan.git
+   F[运维人员] -- 监控维护 --> D[spug devOps平台] 
 
-:::
 
-#  基本业务逻辑图
 
-```mermaid
+```
+
+
 
-sequenceDiagram
-    participant 2D
-    participant 3D
-    participant UI
-    participant 服务端
+# 测试发布流程(免审核)
+
+```mermaid
 
-    2D->>+3D: EventBus
-    3D->>-2D: EventBus
-    2D->>+UI: EventBus
-    UI->>-2D: EventBus
-    2D->>+UI: 提供API获取相关数据/执行某些功能
 
-    3D->>+UI: EventBus
-    UI->>-3D: EventBus
-    3D->>+UI: 提供API获取相关数据/执行某些功能
+graph TD
+   A[开发人员] --按分支规范提交代码 --> B --自动发布 --> D[spug devOps平台] 
 
+   B[测试人员] --反馈上线问题--> F[运维人员] --技术支持--> B[测试人员]
 
-    UI->>+服务端: API
+   F[运维人员] -- 监控维护 --> D[spug devOps平台] 
 
 
 ```

docs/branch.md

@@ -0,0 +1,59 @@
+# 分支命名规范
+
+分支名称规范, 主要基于 git flow 的基础, 保留核心分支 master 为项目线上, dev 做为预发分支, 其他都是以下业务分支命名.
+
+## 分支名称公式
+
+::: info
+
+```bash
+项目名称或简写代号_功能模块名称_YYYYmmdd_其他标识
+```
+
+:::
+
+## 项目名称或简写代号
+
+可以由产品部规范项目名称与代号表格.
+
+例如:
+
+| 项目        |  简写  | 备注 |
+| :---------- | :----: | ---: |
+| 随心装      |  sxz   |      |
+| 随心装-后台 | sxzadm |      |
+
+
+(TBC)
+
+## 功能模块名称
+
+当前迭代的功能的以英文词意为主.
+
+例如: 项目随心装 7 月主功能模块是重构方向,表现第二次, 可以为rebuildV2
+
+```bash
+sxz_rebuildV2_202107010900
+```
+
+
+## 其他标识 (可选)
+
+对于有些项目, 可以同一时代会有平行开发, 故可以加上其他标识.
+
+一般以英文与数字做为标识, 可读性要强.
+
+
+例如: 项目随心装 7 月主功能模块是重构方向, 有2D或UI不同等不同
+
+
+如下:
+
+```bash
+sxz_rebuildV2_202107010900_UI
+```
+
+
+综上, 业务分支以贴合业务唯一性做为敏捷开发, 当期跌代的敏捷汇合.
+
+

docs/docker-compose.yml

@@ -1,9 +1,8 @@
-
 version: "3.7"
 
 services:
   docs:
-    container_name: 4dkankan_docs
+    container_name: bootstap_spug_docs
     image: 192.168.0.163:8077/sxz/docs:latest
     ports:
       - "8066:80"

docs/flow.md

@@ -0,0 +1,3 @@
+# 测试与开发
+
+