From df1c82960184cec763ef5298626282c4897b90a1 Mon Sep 17 00:00:00 2001 From: Juster Zhu Date: Wed, 13 Mar 2024 23:54:12 +0800 Subject: [PATCH] update docs --- website/README.md | 43 ++---- website/doc/en-us/Component introduction.md | 122 ------------------ website/doc/en-us/GeneralUpdate.AspNetCore.md | 23 ---- website/doc/en-us/GeneralUpdate.ClientCore.md | 34 ----- website/doc/en-us/GeneralUpdate.Core.md | 33 ----- .../doc/en-us/GeneralUpdate.Differential.md | 23 ---- website/doc/en-us/GeneralUpdate.PacketTool.md | 28 ---- website/doc/en-us/GeneralUpdate.Single.md | 23 ---- website/doc/en-us/GeneralUpdate.Zip.md | 23 ---- .../doc/zh-cn/ComponentIntroduction.md | 2 +- website/doc/zh-cn/GeneralClient.OSS.md | 4 +- .../doc/zh-cn/GeneralUpdate.SystemService.md | 2 +- website/doc/zh-cn/VersionHub.md | 6 +- website/doc/zh-cn/_category_.json | 7 + 14 files changed, 24 insertions(+), 349 deletions(-) delete mode 100644 website/doc/en-us/Component introduction.md delete mode 100644 website/doc/en-us/GeneralUpdate.AspNetCore.md delete mode 100644 website/doc/en-us/GeneralUpdate.ClientCore.md delete mode 100644 website/doc/en-us/GeneralUpdate.Core.md delete mode 100644 website/doc/en-us/GeneralUpdate.Differential.md delete mode 100644 website/doc/en-us/GeneralUpdate.PacketTool.md delete mode 100644 website/doc/en-us/GeneralUpdate.Single.md delete mode 100644 website/doc/en-us/GeneralUpdate.Zip.md rename "website/doc/zh-cn/\347\273\204\344\273\266\347\256\200\344\273\213.md" => website/doc/zh-cn/ComponentIntroduction.md (98%) create mode 100644 website/doc/zh-cn/_category_.json diff --git a/website/README.md b/website/README.md index 0a02cfd..9a360f4 100644 --- a/website/README.md +++ b/website/README.md @@ -2,7 +2,7 @@ permalink: / --- -# JusterZhu的编程宝典 +# GeneralUpdate Doc > 贴心的编程学习路线，全面的编程知识百科 > @@ -12,62 +12,37 @@ permalink: / ## 本站内容 -- [编程学习路线](/学习路线) -- [JusterZhu的编程学习之路](/自学之路) -- [编程干货分享](/编程分享) -- [原创项目实战](/项目实战) -- [技术知识分享](/知识碎片) -- [编程导航星球](/编程导航) -- [编程产品服务](/产品服务) -- [编程词典](/编程词典) -- [作者介绍](/作者) - - -## [Component introduction](/Component introduction) +## [Component introduction](doc/zh-cn/ComponentIntroduction) 包含 Java、前端、C++、Python、SQL、计算机基础、数据结构和算法、Git & GitHub、Linux、设计模式等多个精心编写的学习路线，帮助程序员快速入门。 -## [GeneralUpdate.AspNetCore](/GeneralUpdate.AspNetCore) - -JusterZhu从 0 到 1 的编程学习经历、求职经历、职场工作、创作经历、创业经历、生活日常等，最真实的经验分享。 - -## [GeneralUpdate.ClientCore](/GeneralUpdate.ClientCore) +## [GeneralUpdate.ClientCore](doc/zh-cn/GeneralUpdate.ClientCore) 程序员JusterZhu的编程学习指南、开发经验、求职经验、职场经验、技术分享、实战教程、项目教程、个人作品、编程资源等，做最接地气的编程干货分享。 -## [GeneralUpdate.Core](/GeneralUpdate.Core) +## [GeneralUpdate.Core](doc/zh-cn/GeneralUpdate.Core) JusterZhu原创的实战项目教程系列，用全程直播的方式，从 0 到 1 带大家学习技术知识，并立即实践运用到项目中，做到学以致用。 - 提供从学知识 => 实践项目 => 复习笔记 => 项目答疑 => 简历写法 => 面试题解的一条龙服务！ - -## [GeneralUpdate.Differential](/GeneralUpdate.Differential) +## [GeneralUpdate.Differential](doc/zh-cn/GeneralUpdate.Differential) 通过简单的技术知识分享，帮助大家快速学习或复习巩固项目开发中的重点知识，便于把控学习进度、并且持续加深印象。 -## [GeneralUpdate.Single](/GeneralUpdate.Single) - -JusterZhu公司旗下的产品和服务，如后端求职突击、前端面试突击、考研陪跑、求职简历工具、嵌入式精英教程等。 - -## [GeneralUpdate.Zip](/GeneralUpdate.Zip) +## [GeneralUpdate.Zip](doc/zh-cn/GeneralUpdate.Zip) 计算机编程领域专业术语大全，覆盖 Java、Python、前端、Go、C++、游戏开发、人工智能、大数据、云计算、区块链、机器学习、深度学习、网络安全、算法、操作系统、数据库、物联网、嵌入式、移动开发等 30 个方向。 -## [GeneralUpdate.PacketTool](/GeneralUpdate.PacketTool) +## [GeneralUpdate.PacketTool](doc/zh-cn/GeneralUpdate.PacketTool) 由程序员JusterZhu创建的，帮助你更快学好编程、少走弯路的圈子，提供百万字学习指南、求职指南、原创项目教程、直播经验分享、编程交流等服务，是国内顶尖的编程学习交流社区。 - - -## 启动项目编译 +## 网站本地启动项目编译 运行环境 -Node.js - - +Node.js ， VisualStudio Code 启动命令 diff --git a/website/doc/en-us/Component introduction.md b/website/doc/en-us/Component introduction.md deleted file mode 100644 index 6fbf575..0000000 --- a/website/doc/en-us/Component introduction.md +++ /dev/null @@ -1,122 +0,0 @@ -### 1.GeneralUpdate是什么？ - -GeneralUpdate将被规划为全平台全栈软件，不受限任何语言或技术的自动更新组件。 - -##### 开源地址 - -- https://github.com/JusterZhu/GeneralUpdate -- https://gitee.com/Juster-zhu/GeneralUpdate - -##### 帮助文档 ##### - -- 讲解视频： https://www.bilibili.com/video/BV1aX4y137dd -- 官方网站： http://justerzhu.cn/ -- 快速启动： https://mp.weixin.qq.com/s/pRKPFe3eC0NSqv9ixXEiTg -- 使用教程视频：https://www.bilibili.com/video/BV1FT4y1Y7hV - -##### 沟通交流 - -- 免费问题解答： https://github.com/JusterZhu/GeneralUpdate/issues -- 免费技术交流： -- 开源项目使用讨论： - - - -##### 商务合作 - -定制化二次开发，技术咨询。 - -- 邮箱：zhuzhen723723@outlook.com - - - -## 2.统一语言（Unifying Language） - -在开始使用GeneralUpdate之前我们需要先知道体系中的一些基础概念。 - -- Client：是指你的主应用程序，是被更新的客户端。也可理解为是公司的产品。 - -- Upgrade:是指升级程序，它将是一个独立的进程。需要和Client放在同一级目录下，在使用（或编码）的过程中不可以和任何业务或设计关联、必须保持独立引用。 -- Server:是指服务端应用（ASP.NET）将提供版本更新信息交互、版本验证功能。 - - - -### 3.GeneralUpdate提供什么？ - -##### 组件功能 - -| **功能** | **是否支持** | **备注** | -| ------------------------------ | ------------ | ------------------------------------------------------------ | -| 断点续传 | 支持 | | -| 逐版本更新 | 支持 | | -| 二进制差分更新 | 支持 | | -| 增量更新功能 | 支持 | | -| 配置文件保留更新 | 支持 | 目前指支持深度为1的json配置文件 | -| 强制更新 | 支持 | 非强制更新可以弹出选择框供用户选择，强制更新则直接更新 | -| 多分支更新 | 支持 | 当一个产品有多个分支时，需要根据不同的分支更新对应的内容 | -| 版本校验、更新信息 | 支持 | 可验证版本是否需要更新 | -| 最新版本推送 | 支持 | 基于SignalR实现 | -| 客户端程序、服务端程序应用更新 | 支持 | C/S和B/S程序均可使用 | -| 多平台、操作系统 | 部分支持 | Linux、MacCatalyst、Windows | -| 多语言 | 待验证 | 也可将本组件编写为控制台程序，作为更新“脚本”。供其他语言的应用程序调用更新。 | - - - -##### 打包工具 - -GeneralUpdate.PacketTool使用.NET MAUI（.NET 6）编写的桌面端打包程序。 - -| 功能 | 支持 | 备注 | -| ------------------ | ------ | ------------------------------------------------------------ | -| 差分更新包生成 | 是 | 根据上一个版本和当前版本进行对比找出需要更新的文件或新添加文件。 | -| 自动上传更新包 | 开发中 | 将生成好的差分更新包自动上传至服务器。 | -| 可编辑选择差分文件 | 开发中 | 可视化查看差分包的打包内容，并可选择打包文件。 | -| 多平台支持 | 部分 | 仅支持Windows、Linux、MacCatalyst。 | - - - -### 4.GeneralUpdate支持什么？ - -##### .NET框架 - -| 框架名称 | 是否支持 | -| -------------------- | -------- | -| .NET Core 2.0 | 支持 | -| .NET 5 6 7 8 | 支持 | -| .NET Framework 4.6.1 | 支持 | - - - -##### UI框架 - -| UI框架名称 | 是否支持 | -| ----------------- | ------------------- | -| WPF | 支持 | -| UWP | 商店模式下不可更新 | -| MAUI | 正在兼容（windows） | -| Avalonia | 支持 | -| WinUI | 待验证，等待反馈 | -| Console（控制台） | 支持 | -| Winform | 支持 | - - - -##### 服务端框架 - -| 服务端框架 | 是否支持 | -| ---------- | -------- | -| ASP.NET | 待验证 | - - - -##### 操作系统 - -| 操作系统名称 | 是否支持 | -| -------------------------------- | -------- | -| Windows | 支持 | -| Linux | 支持 | -| MacCatalyst | 支持 | -| iOS | 暂不支持 | -| Android | 暂不支持 | -| 树莓派(IoT) | 待验证 | -| 国产操作系统（华为海思、麒麟等） | 待验证 | \ No newline at end of file diff --git a/website/doc/en-us/GeneralUpdate.AspNetCore.md b/website/doc/en-us/GeneralUpdate.AspNetCore.md deleted file mode 100644 index 4166d04..0000000 --- a/website/doc/en-us/GeneralUpdate.AspNetCore.md +++ /dev/null @@ -1,23 +0,0 @@ -## GeneralUpdate.AspNetCore - -#### 简介 - - - -#### 提供功能 - - - -#### 使用示例 - -1.安装 - -TODO:截图安装，文字解释 - -2.初始化 - -TODO:代码 - -3.启动 - -TODO:运行效果 \ No newline at end of file diff --git a/website/doc/en-us/GeneralUpdate.ClientCore.md b/website/doc/en-us/GeneralUpdate.ClientCore.md deleted file mode 100644 index a55f7fe..0000000 --- a/website/doc/en-us/GeneralUpdate.ClientCore.md +++ /dev/null @@ -1,34 +0,0 @@ -## GeneralUpdate.ClientCore - -#### 简介 - -GeneralUpdate.ClientCore是最核心的组件之一，提供了大量主要功能。本质和Core没有区别，但是有职责上的区别ClientCore用于主程序中，更新升级助手然后关闭主程序启动升级助手。 - -#### 提供功能 - -| **功能** | **是否支持** | **备注** | -| ---------------- | ------------ | -------------------------------------------------------- | -| 断点续传 | 支持 | | -| 逐版本更新 | 支持 | | -| 二进制差分更新 | 支持 | | -| 增量更新功能 | 支持 | | -| 配置文件保留更新 | 支持 | 目前指支持深度为1的json配置文件 | -| 强制更新 | 支持 | 非强制更新可以弹出选择框供用户选择，强制更新则直接更新 | -| 多分支更新 | 支持 | 当一个产品有多个分支时，需要根据不同的分支更新对应的内容 | -| 最新版本推送 | 支持 | 基于SignalR实现 | - - - -#### 使用示例 - -1.安装 - -TODO:截图安装，文字解释 - -2.初始化 - -TODO:代码 - -3.启动 - -TODO:运行效果 \ No newline at end of file diff --git a/website/doc/en-us/GeneralUpdate.Core.md b/website/doc/en-us/GeneralUpdate.Core.md deleted file mode 100644 index 9bf1cf4..0000000 --- a/website/doc/en-us/GeneralUpdate.Core.md +++ /dev/null @@ -1,33 +0,0 @@ -## GeneralUpdate.Core - -#### 简介 - -GeneralUpdate.Core是最核心的组件之一，提供了大量主要功能。 - -#### 提供功能 - -| **功能** | **是否支持** | **备注** | -| ---------------- | ------------ | -------------------------------------------------------- | -| 断点续传 | 支持 | | -| 逐版本更新 | 支持 | | -| 二进制差分更新 | 支持 | | -| 增量更新功能 | 支持 | | -| 配置文件保留更新 | 支持 | 目前指支持深度为1的json配置文件 | -| 强制更新 | 支持 | 非强制更新可以弹出选择框供用户选择，强制更新则直接更新 | -| 多分支更新 | 支持 | 当一个产品有多个分支时，需要根据不同的分支更新对应的内容 | - - - -#### 使用示例 - -1.安装 - -TODO:截图安装，文字解释 - -2.初始化 - -TODO:代码 - -3.启动 - -TODO:运行效果 \ No newline at end of file diff --git a/website/doc/en-us/GeneralUpdate.Differential.md b/website/doc/en-us/GeneralUpdate.Differential.md deleted file mode 100644 index ee1def1..0000000 --- a/website/doc/en-us/GeneralUpdate.Differential.md +++ /dev/null @@ -1,23 +0,0 @@ -## GeneralUpdate.Differential - -#### 简介 - - - -#### 提供功能 - - - -#### 使用示例 - -1.安装 - -TODO:截图安装，文字解释 - -2.初始化 - -TODO:代码 - -3.启动 - -TODO:运行效果 \ No newline at end of file diff --git a/website/doc/en-us/GeneralUpdate.PacketTool.md b/website/doc/en-us/GeneralUpdate.PacketTool.md deleted file mode 100644 index d2a8b15..0000000 --- a/website/doc/en-us/GeneralUpdate.PacketTool.md +++ /dev/null @@ -1,28 +0,0 @@ -## GeneralUpdate.PacketTool - -#### 简介 - -工具使用.NET MAUI (.NET 6)进行开发，目前只支持桌面端使用。 - -#### 提供功能 - -| 功能 | 支持 | 备注 | -| ------------------ | ------ | ------------------------------------------------------------ | -| 差分更新包生成 | 是 | 根据上一个版本和当前版本进行对比找出需要更新的文件或新添加文件。 | -| 自动上传更新包 | 开发中 | 将生成好的差分更新包自动上传至服务器。 | -| 可编辑选择差分文件 | 开发中 | 可视化查看差分包的打包内容，并可选择打包文件。 | -| 多平台支持 | 部分 | 仅支持Windows、Linux、MacCatalyst。 | - -#### 使用示例 - - - -Source path：表示上一个版本的文件夹路径。 - -Target path：表示当前版本文件夹路径。 - -Patch path：表示最终生成差分包的路径。 - -Is Publish：如果勾选则将生成好的差分包通过HTTP上传，并自动在数据库插入本次发布的版本信息。 - -Build：通过递归比对Source path和Target path文件夹下所有的工程文件（DLL，exe...等），通过二进制差分检查、增量检查分析出需要更新的文件列表按照文件夹结构，打包更新包。 \ No newline at end of file diff --git a/website/doc/en-us/GeneralUpdate.Single.md b/website/doc/en-us/GeneralUpdate.Single.md deleted file mode 100644 index 8a2cf8f..0000000 --- a/website/doc/en-us/GeneralUpdate.Single.md +++ /dev/null @@ -1,23 +0,0 @@ -## GeneralUpdate.Single - -#### 简介 - - - -#### 提供功能 - - - -#### 使用示例 - -1.安装 - -TODO:截图安装，文字解释 - -2.初始化 - -TODO:代码 - -3.启动 - -TODO:运行效果 \ No newline at end of file diff --git a/website/doc/en-us/GeneralUpdate.Zip.md b/website/doc/en-us/GeneralUpdate.Zip.md deleted file mode 100644 index 8388d6d..0000000 --- a/website/doc/en-us/GeneralUpdate.Zip.md +++ /dev/null @@ -1,23 +0,0 @@ -## GeneralUpdate.ZIP - -#### 简介 - - - -#### 提供功能 - - - -#### 使用示例 - -1.安装 - -TODO:截图安装，文字解释 - -2.初始化 - -TODO:代码 - -3.启动 - -TODO:运行效果 \ No newline at end of file diff --git "a/website/doc/zh-cn/\347\273\204\344\273\266\347\256\200\344\273\213.md" b/website/doc/zh-cn/ComponentIntroduction.md similarity index 98% rename from "website/doc/zh-cn/\347\273\204\344\273\266\347\256\200\344\273\213.md" rename to website/doc/zh-cn/ComponentIntroduction.md index bf99698..4210f75 100644 --- "a/website/doc/zh-cn/\347\273\204\344\273\266\347\256\200\344\273\213.md" +++ b/website/doc/zh-cn/ComponentIntroduction.md @@ -72,7 +72,7 @@ ### 版本号执行标准 - Nuget版本管理参考标准：https://docs.microsoft.com/zh-cn/nuget/concepts/package-versioning -- 应用程序集版本管理参考标准：https://docs.microsoft.com/zh-cn/dotnet/standard/assembly/versi oning （被组件更新的客户端程序，说通俗点就是你公司的产品；组件的操作将按照这个标准执行。） +- 应用程序集版本管理参考标准：https://docs.microsoft.com/zh-cn/dotnet/standard/assembly/versioning （被组件更新的客户端程序，说通俗点就是你公司的产品；组件的操作将按照这个标准执行。） - 每次迭代除了更新AssemblyInfo中的版本号，还需要修改DLL文件的版本号。 diff --git a/website/doc/zh-cn/GeneralClient.OSS.md b/website/doc/zh-cn/GeneralClient.OSS.md index b596936..496c47c 100644 --- a/website/doc/zh-cn/GeneralClient.OSS.md +++ b/website/doc/zh-cn/GeneralClient.OSS.md @@ -112,7 +112,7 @@ GeneralUpdateOSS提供以下能力。 Starting an OSS update. ```c# -public static async Task Start(ParamsOSS configParams, string upgradeAppName = "GeneralUpdate.Upgrade") +public static async Task Start(ParamsOSS configParams, string upgradeAppName = "GeneralUpdate.Upgrade"); ``` @@ -127,6 +127,8 @@ ParamsOSS 更新配置参数，详细内容参考本文档 funcAddListenerDownloadProcess() diff --git a/website/doc/zh-cn/GeneralUpdate.SystemService.md b/website/doc/zh-cn/GeneralUpdate.SystemService.md index 694ce42..99e2416 100644 --- a/website/doc/zh-cn/GeneralUpdate.SystemService.md +++ b/website/doc/zh-cn/GeneralUpdate.SystemService.md @@ -8,7 +8,7 @@ -GeneralUpdate.SystemService是一个跨平台的操作系统服务，它几乎不参与任何更新（如果需要更新则需要考虑附加在客户端的安装包里）。它的主要作用是帮助恢复客户端文件损坏导致无法正常运行，无差别回滚到上一个版本。 +GeneralUpdate.SystemService是一个跨平台的操作系统服务，它几乎不参与任何更新（如果需要更新则需要考虑附加在客户端的安装包里）。它的主要作用是帮助恢复客户端文件损坏导致无法正常运行，无差别回滚到上一个版本整个过程称之为遗言机制（WillMessage）。 ```c# using GeneralUpdate.SystemService.Services; diff --git a/website/doc/zh-cn/VersionHub.md b/website/doc/zh-cn/VersionHub.md index 7d75aae..c4ae6d9 100644 --- a/website/doc/zh-cn/VersionHub.md +++ b/website/doc/zh-cn/VersionHub.md @@ -31,13 +31,13 @@ NuGet\Install-Package GeneralUpdate.ClientCore -Version 1.0.0 VersionHub.Instance.Subscribe($"{baseUrl}/{hubName}", "TESTNAME", new Action(GetMessage)); ``` -**点对点推送** +**（1）点对点推送** maui_windows_push_version -**一次推送更新给多个客户端** +**（2）一次推送更新给多个客户端** ![push_version_mutil](../imgs/push_version_mutil.png) @@ -45,7 +45,7 @@ VersionHub.Instance.Subscribe($"{baseUrl}/{hubName}", "TESTNAME", new Ac ### 注解 -VersionHub提供以下能力。 +VersionHub提供服务器对客户端一对一、一对多的推送功能。 #### 属性 diff --git a/website/doc/zh-cn/_category_.json b/website/doc/zh-cn/_category_.json new file mode 100644 index 0000000..a8ffcc1 --- /dev/null +++ b/website/doc/zh-cn/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Tutorial - Extras", + "position": 3, + "link": { + "type": "generated-index" + } +}