Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions website/docs/doc/_category_.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Doc",
"position": 1,
"label": "Components",
"position": 2,
"link": {
"type": "generated-index",
"description": "GeneralUpdate开源项目在线文档."
"description": "GeneralUpdate 组件参考文档 — 涵盖 Core、Bowl、Differential、Drivelution 与 Extension 五大非固件组件。"
}
}
6 changes: 3 additions & 3 deletions website/docs/guide/_category_.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Guide",
"position": 1,
"label": "Guides",
"position": 7,
"link": {
"type": "generated-index",
"description": "指南."
"description": "平台与运维指南。"
}
}
29 changes: 29 additions & 0 deletions website/docs/quickstart/Advanced cookbook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_position: 4
title: 高级实战手册
---

# GeneralUpdate 高级实战手册

> **目标读者**:已有基础使用经验的开发者,正在将 GeneralUpdate 集成到生产产品、CI/CD 流水线和企业级发布工作流中。

## 内容概览

本手册覆盖以下主题:

1. **生产更新架构设计** — Client、Upgrade、Server、OSS、Tools 与 CI 的整体拓扑
2. **标准化发布物** — 应用程序包、补丁包、扩展包、OSS 配置的生成与版本管理
3. **CI/CD 集成** — 在 GitHub Actions / 内部流水线中触发补丁生成
4. **版本策略** — SemVer、分支发布、渐进式推送、强制更新、多版本顺序升级
5. **差分策略** — 何时使用差分、删除文件处理、黑名单、大文件场景
6. **可靠性设计** — Bowl 监控、备份、回滚、启动验证、日志收集
7. **扩展系统** — Manifest 设计、扩展包发布、兼容性检查、依赖管理
8. **驱动更新** — Drivelution 权限、签名、平台差异、回滚与重启策略
9. **安全合规** — Hash 校验、认证下载、OSS 权限、发布审计
10. **故障演练** — 模拟下载失败、文件锁定、启动崩溃、补丁损坏、权限不足

## 章节索引

各章节具体内容正在编写中,详见以下子页面:

> **状态说明**:本文档正在积极构建中。如果你已积累生产实战经验,欢迎通过 Issue 或 PR 贡献案例。
4 changes: 2 additions & 2 deletions website/docs/quickstart/_category_.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Quik start",
"label": "Quick Start",
"position": 1,
"link": {
"type": "generated-index",
"description": "Quik start."
"description": "快速入门与实战手册。"
}
}
6 changes: 3 additions & 3 deletions website/docs/releaselog/_category_.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Release log",
"position": 1,
"label": "Release Log",
"position": 8,
"link": {
"type": "generated-index",
"description": "发布日志."
"description": "GeneralUpdate 发布日志与版本路线。"
}
}
52 changes: 28 additions & 24 deletions website/i18n/en/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,40 @@
"message": "Next",
"description": "The label for version current"
},
"sidebar.tutorialSidebar.category.Doc": {
"message": "Doc",
"description": "The label for category Doc in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Quick Start": {
"message": "Quick Start",
"description": "The label for category Quick Start in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Doc.link.generated-index.description": {
"message": "GeneralUpdate开源项目在线文档.",
"description": "The generated-index page description for category Doc in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Advanced Cookbook": {
"message": "Advanced Cookbook",
"description": "The label for category Advanced Cookbook in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Guide": {
"message": "Guide",
"description": "The label for category Guide in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Components": {
"message": "Components",
"description": "The label for category Components in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Guide.link.generated-index.description": {
"message": "指南.",
"description": "The generated-index page description for category Guide in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Tools": {
"message": "Tools",
"description": "The label for category Tools in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Quik start": {
"message": "Quik start",
"description": "The label for category Quik start in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Infrastructure": {
"message": "Infrastructure",
"description": "The label for category Infrastructure in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Quik start.link.generated-index.description": {
"message": "Quik start.",
"description": "The generated-index page description for category Quik start in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.OSS Update Mode": {
"message": "OSS Update Mode",
"description": "The label for category OSS Update Mode in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Release log": {
"message": "Release log",
"description": "The label for category Release log in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Utilities": {
"message": "Utilities",
"description": "The label for category Utilities in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Release log.link.generated-index.description": {
"message": "发布日志.",
"description": "The generated-index page description for category Release log in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Guides": {
"message": "Guides",
"description": "The label for category Guides in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Release Log": {
"message": "Release Log",
"description": "The label for category Release Log in sidebar tutorialSidebar"
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Doc",
"position": 1,
"label": "Components",
"position": 2,
"link": {
"type": "generated-index",
"description": "GeneralUpdate open source project online documentation."
"description": "GeneralUpdate component reference — covering the five non-firmware components: Core, Bowl, Differential, Drivelution, and Extension."
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Guide",
"position": 1,
"label": "Guides",
"position": 7,
"link": {
"type": "generated-index",
"description": "Guide."
"description": "Platform and operations guides."
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_position: 4
title: Advanced cookbook
---

# GeneralUpdate advanced cookbook

> **Target audience**: developers who have basic GeneralUpdate experience and are integrating it into production products, CI/CD pipelines, and enterprise release workflows.

## Overview

This cookbook covers:

1. **Production update architecture** — overall topology of Client, Upgrade, Server, OSS, Tools, and CI
2. **Standardized release artifacts** — application packages, patch packages, extension packages, OSS configuration
3. **CI/CD integration** — triggering patch generation in GitHub Actions / internal pipelines
4. **Version strategy** — SemVer, branch releases, staged rollout, forced updates, multi-version sequential upgrades
5. **Differential strategy** — when to use differential, handling deleted files, blacklists, large-file scenarios
6. **Reliability design** — Bowl monitoring, backup, rollback, startup validation, log collection
7. **Extension system** — manifest design, extension package publishing, compatibility, dependency management
8. **Driver updates** — Drivelution permissions, signatures, platform differences, rollback and restart strategy
9. **Security and compliance** — hash validation, authenticated downloads, OSS permissions, release audit
10. **Failure drills** — simulate download failure, file lock, startup crash, corrupted patch, insufficient permissions

## Chapter index

Detailed content for each chapter is under active development. See the sub-pages below:

> **Status**: this document is under active construction. If you have production experience to share, PRs and issues are welcome.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Quick start",
"label": "Quick Start",
"position": 1,
"link": {
"type": "generated-index",
"description": "Quick start."
"description": "Quick start guides and hands-on cookbooks."
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Release log",
"position": 1,
"label": "Release Log",
"position": 8,
"link": {
"type": "generated-index",
"description": "Release log."
"description": "GeneralUpdate release notes and version roadmap."
}
}
52 changes: 28 additions & 24 deletions website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,40 @@
"message": "Next",
"description": "The label for version current"
},
"sidebar.tutorialSidebar.category.Doc": {
"message": "Doc",
"description": "The label for category Doc in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Quick Start": {
"message": "快速入门",
"description": "The label for category Quick Start in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Doc.link.generated-index.description": {
"message": "GeneralUpdate开源项目在线文档.",
"description": "The generated-index page description for category Doc in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Advanced Cookbook": {
"message": "高级实战手册",
"description": "The label for category Advanced Cookbook in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Guide": {
"message": "Guide",
"description": "The label for category Guide in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Components": {
"message": "组件文档",
"description": "The label for category Components in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Guide.link.generated-index.description": {
"message": "指南.",
"description": "The generated-index page description for category Guide in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Tools": {
"message": "工具",
"description": "The label for category Tools in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Quik start": {
"message": "Quik start",
"description": "The label for category Quik start in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Infrastructure": {
"message": "基础设施",
"description": "The label for category Infrastructure in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Quik start.link.generated-index.description": {
"message": "Quik start.",
"description": "The generated-index page description for category Quik start in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.OSS Update Mode": {
"message": "OSS 更新模式",
"description": "The label for category OSS Update Mode in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Release log": {
"message": "Release log",
"description": "The label for category Release log in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Utilities": {
"message": "工具类",
"description": "The label for category Utilities in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Release log.link.generated-index.description": {
"message": "发布日志.",
"description": "The generated-index page description for category Release log in sidebar tutorialSidebar"
"sidebar.tutorialSidebar.category.Guides": {
"message": "指南",
"description": "The label for category Guides in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Release Log": {
"message": "发布日志",
"description": "The label for category Release Log in sidebar tutorialSidebar"
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Doc",
"position": 1,
"label": "组件文档",
"position": 2,
"link": {
"type": "generated-index",
"description": "GeneralUpdate开源项目在线文档."
"description": "GeneralUpdate 组件参考文档 — 涵盖 Core、Bowl、Differential、Drivelution 与 Extension 五大非固件组件。"
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Guide",
"position": 1,
"label": "指南",
"position": 7,
"link": {
"type": "generated-index",
"description": "指南."
"description": "平台与运维指南。"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_position: 4
title: 高级实战手册
---

# GeneralUpdate 高级实战手册

> **目标读者**:已有基础使用经验的开发者,正在将 GeneralUpdate 集成到生产产品、CI/CD 流水线和企业级发布工作流中。

## 内容概览

本手册覆盖以下主题:

1. **生产更新架构设计** — Client、Upgrade、Server、OSS、Tools 与 CI 的整体拓扑
2. **标准化发布物** — 应用程序包、补丁包、扩展包、OSS 配置的生成与版本管理
3. **CI/CD 集成** — 在 GitHub Actions / 内部流水线中触发补丁生成
4. **版本策略** — SemVer、分支发布、渐进式推送、强制更新、多版本顺序升级
5. **差分策略** — 何时使用差分、删除文件处理、黑名单、大文件场景
6. **可靠性设计** — Bowl 监控、备份、回滚、启动验证、日志收集
7. **扩展系统** — Manifest 设计、扩展包发布、兼容性检查、依赖管理
8. **驱动更新** — Drivelution 权限、签名、平台差异、回滚与重启策略
9. **安全合规** — Hash 校验、认证下载、OSS 权限、发布审计
10. **故障演练** — 模拟下载失败、文件锁定、启动崩溃、补丁损坏、权限不足

## 章节索引

各章节具体内容正在编写中,详见以下子页面:

> **状态说明**:本文档正在积极构建中。如果你已积累生产实战经验,欢迎通过 Issue 或 PR 贡献案例。
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Quik start",
"label": "快速入门",
"position": 1,
"link": {
"type": "generated-index",
"description": "Quik start."
"description": "快速入门与实战手册。"
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Release log",
"position": 1,
"label": "发布日志",
"position": 8,
"link": {
"type": "generated-index",
"description": "发布日志."
"description": "GeneralUpdate 发布日志与版本路线。"
}
}
Loading
Loading