InnerSourceCommons / InnerSourceCommons/InnerSourceLearningPath

Inline workbook in each article

未关闭
#396 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Website Workbook
主要语言
JavaScript
星标
77
派生
47
平均合并
11 小时 11 分钟
30 天内合并 PR
5

描述

In Should we use hugo-quiz to host workbook? we investigated how to get the workbook questions on innersourcecommons.org. As detailed in that issue, we were able to use quizdown-js to get it working. Here is the relevant commit showing how to wire it up.

Now we need to adjust the script that generates the site pages to include the correct markup for having the workbook questions on the site (in addition to the articles and videos). We were thinking that we could accomplish this by moving the workbook questions from their current location (separate document) to embedded along with each article. Then the autogeneration script could parse them out of there when producing the pages for innersourcecommons.org.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

查看链接的 hugo-quiz 调查和所引用的 innersourcecommons.org commit,以了解现有的 quizdown-js 标记。然后定位单独的 workbook 源文件、文章内容以及生成站点页面的脚本。完成的标准是:每篇文章中都嵌入 workbook 问题,并且生成的页面在文章和视频旁包含所需的 quiz 标记。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
content, documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。