Skip to content

proposal(web): 使用 GitHub Pages 自动部署站点,统一官网与仓库 web 内容 #255

@JasonZhaoWW

Description

@JasonZhaoWW

背景

目前仓库中的 web/ 已回退,但官网 https://learn.shareai.run 仍停留在4.8的版本,导致线上内容与仓库当前代码、README、课程结构不完全一致。

这种不一致会带来比较明显的问题:

  • 用户从官网进入时看到的是旧内容
  • 贡献者在仓库里更新的 web/ 不能稳定反映到线上
  • 仓库源码、文档和线上演示之间缺少明确的一致性保证

现状观察

  • web/next.config.ts 已配置 output: "export"trailingSlash: true
  • 当前 web 本身就是适合静态部署的结构
  • 仓库里已有 web build 的 CI,但暂未看到明确的自动部署到线上站点的流程
  • 仓库主页已经指向官网地址,但官网内容与 repo 中的 web 内容存在滞后

建议

考虑将教程站点切换为基于 GitHub Pages 的自动部署方案:

  • main 分支中的 web/ 为来源
  • 每次合并到 main 后自动构建并部署静态站点
  • 保留当前自定义域名,绑定到 GitHub Pages
  • 明确线上站点与仓库源码的同步关系,避免“仓库更新了但官网没更新”的问题

如果需要的话,我可以帮忙提pr通过github action自动更新,但是自定义域名和github page的功能还需要请maintainer来开启。

通过这一方式部署的话,后续也方便使用giscus来作为文章讨论区,利于读者交流和发表看法,也更利于该项目的迭代优化,如果可以的话,我也可以帮忙提pr做文章讨论区(直接使用giscus实现,不需要额外的服务器/数据库负担),不过同样也需要maintainer开启discussion功能。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions