Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

数字课本技术选型与基础设施的搭建 @wangyantong2000 #391

Open
Tracked by #383
will-ww opened this issue Apr 6, 2024 · 6 comments
Open
Tracked by #383

数字课本技术选型与基础设施的搭建 @wangyantong2000 #391

will-ww opened this issue Apr 6, 2024 · 6 comments

Comments

@will-ww
Copy link
Contributor

will-ww commented Apr 6, 2024

简单来说,第一步就是确定 oss101 数字课本的基础设施方案。此部分的几个重要需求包括:

  • 能够在 GitHub 上的仓库中进行多人协作生产内容
  • 能够自动将仓库中的内容在前端中进行渲染,作为一个阅读体验良好的在线服务交付
  • 能够方便的和读者进行互动(例如点赞、提反馈意见等)
  • 能够同时支持 PC 端和移动端
  • 能够支持响应式设计与布局
  • 后续能够方便的在不同的平台上进行移植,例如 Gitee / AtomGit 等
  • 能够方便的支持 SVG 格式的图片嵌入

上述要求较多,但也不是需要全部一起考虑,可以一步步的做起来。请 @bifenglin @wj23027 @wangyantong2000 一起来确定下,《开源软件通识》数字课本的技术选型,有三个可供参考:

其中,第一个方案是一本 GitHub 上的热门书籍技术方案,目前已经出版;第二和第三也都是我们实验室实践过的,如果还有其它更合适的方案,大家可以提出来~

@will-ww
Copy link
Contributor Author

will-ww commented Apr 6, 2024

该子任务的一个简单分工可以是:

  • @bifenglin:项目经理,协调相关工作、资源调度、时间进度把握
  • @wj23027:产品经理,从用户体验的角度出发,规划与设计该产品
  • @wangyantong2000:研发工程师,负责具体基础设施的搭建与迭代

等大体的方案与框架确定好后,还可以邀请更多低年级的同学一同加入~

@bifenglin
Copy link
Contributor

bifenglin commented Apr 8, 2024

数字课本技术选型与基础设施,考虑到需要利用github平台协作,与 @wangyantong2000 充分讨论后,选取hello算法 一致的技术选型,使用mkdocs
@wangyantong2000 可以先根据#383 里面内容,将网站目录框架搭建好,暂时托管到GitHub平台上。等待其他人提交内容的PR

@wangyantong2000
Copy link
Member

okok

@wangyantong2000
Copy link
Member

目前,我是采用mkdocs和giscus进行了项目文档网站搭建的尝试,构建了一个个人blog文档网站地址。如果这个方案是可行的,那么下一步需要在实验室github开个数字课本仓库,和一些主页等页面和功能的想法和设计,以及一些图标、名称等细化的想法。

@wj23027
Copy link

wj23027 commented Apr 25, 2024

关于数字课本的产品设计,可以参考helo算法,主要需要构建以下几个部分

主页:

  • oss101课程介绍
  • oss101数字课本介绍
  • 课程大纲(目录)

课本内容页:

  • 导航栏(返回主页、搜索课本内容)
  • 分级目录
  • 点赞/评论

可以先利用已有的资源搭建好框架,后续再考虑加入SVG 格式的图片嵌入、中英文切换、响应式布局等更丰富的功能~

@wangyantong2000
Copy link
Member

wangyantong2000 commented May 6, 2024

做了一个大概的框架,地址:http://x-lab2017.github.io/digital-textbooks/,仓库:https://github.com/X-lab2017/digital-textbooks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants