充分利用 GitHub 上的信息转换功能，建立内容贡献流程

[will-ww]

由于 GitHub 上有良好的信息转换功能，因此可以建立起一个信息扭转的贡献链：

Discussion ➡️ Issue ➡️ PR ➡️ Review ➡️ Wiki / Doc 等等

• 一些最初的想法，可以从 Discussion 开始，头脑风暴；
• 相对成熟后，可以设立正式的 Issue 议题；
• 值得做的议题，就可以有认领或安排责任人来完成；
• 责任人通过 PR 进行贡献提交；
• 完成 Reveiw 后合并到正式的仓库上面。

形成一个完整的内容贡献流程~

Originally posted by @will-ww in #32 (comment)

[will-ww]

关于论文分享集的想法和流程。

论文阅读工作是研究生的重要事宜，好的论文值得更多的人看到，并进行思想碰撞，最终形成一份年度的 **OpenReading** 文集，步骤：

1. 从 Discussion 或 Issue 上起步，发起要阅读的论文
2. 确定后，填写一份 **Reading plan proposal, RPP** ，明确主题
3. 进入到 Issue 中，深度阅读（如果是 Discussion 中发起的，可以转换成 Issue）
4. 在组会等活动上进行分享，获取反馈与启发（内部分享与讨论）
5. 会后视频发B站，并撰写论文分享报告 **Reading report, RR**
6. 在 Discussion 中进行发布，并后续讨论与交流（外部分享与讨论）

• 选择一个自己喜欢的工具（如语雀）或格式（推荐markdown）
• 发布 RR 初稿，将初稿链接到 Discussion 中，或直接在 Discussion 中撰写
• 在 Discussion 中收获外部建议后，迭代优化下 RR 内容
• 提交一个 PR 请求合并到仓库中，

7. 关闭相关 issue
8. 在其它平台上进行宣传，例如微信公众号等
9. 循环 1~8 步骤，每个季度出一本论文分享的文集 **OpenReading**
10. OpenReading 文集进一步宣传和发布，例如利用 Gitbook 等工具

**Reading plan proposal, RPP** 要素：

• 论文题目（Title）
• 作者与机构背景（Author and affiliation）
• 发表年份（Year）
• 发表会议或期刊（Conference or Journal）
• 级别（参照CCF级别）（Ranking）
• 论文链接（Link）
• 选题原因（Select reason）
• 相关论文背景补充（可选）（Background）

**Reading report, RR** 要素：

• RPP 的引用
• 论文摘要（Abstract）
• 主题内容（Main content）
• 内部讨论内容（X-lab disscususion）
• 外部讨论内容（可选）（Open discussion）
• 思考与启发（Inspired thinking）

两个范例：

• https://www.yuque.com/shibudengqinsheng/ggwvkm/eri2s3
• https://www.yuque.com/tyn1998/blogs/cs1unx

Discussion 上发布的效果：

• https://github.com/X-lab2017/open-research/discussions/34

[tyn1998]

• 发布 RR 初稿，将初稿链接到 Discussion 中，或直接在 Discussion 中撰写
• 在 Discussion 中收获外部建议后，迭代优化下 RR 内容
• 提交一个 PR 请求合并到仓库中，

王老师，我感受了下 #34 的效果，觉得在Discussion里放Reading Report对读者不够友好：

• GitHub的Markdown渲染引擎不支持LaTeX公式，可以看到RR的一些公式没渲染出来
• 字体、行间距、图片大小等排版因素造成的阅读困难
• 没有侧边索引目录，无法快速跳转到长文的各个部分

也许我们可以挑选一个博客引擎和博客主题，使每篇RR都是由博客引擎用markdown文件生成的，如这样。这样，RR迭代的流程为：

1. 作者用语雀等工具写文章（我个人推荐图片也用语雀的图床，不需要图片跟着md走）
2. 在语雀中导出为markdown格式
3. 稍微修改一下导出的markdown格式，使其符合博客引擎的要求
4. 本地run一下博客，自己先看看博客渲染效果
5. 自己看得差不多了，以PR的形式提交这篇RR
6. 触发GitHub的Action，自动将PR中的markdown渲染为文章，将此PR部署到线上，并由bot给出对应链接。就像Frank在OpenGalaxy中做的那样。
7. 其他读者点进链接，阅读排版精美的RR，并在PR中给出建议
8. 作者做出相应修改，push新的commit上来，再次触发Action
9. 并且由于PR中可以看diff，作者改了哪些地方将是一目了然
10. 大家觉得改的差不多了，合并PR到main分支
11. 触发另一个GitHub Action，也就是将最新的main分支版本替换掉线上版本
12. 流程结束

博客网站可以专门是做open-research的；也可以是X-lab官网的一部分。

[will-ww]

好棒，那我们就这么定下来。

我们可以一起补充到：https://github.com/X-lab2017/open-research/blob/main/OpenReading/README.md

正好也借此机会把 X-lab 官网也弄下，志成可以把 ONES 官网的经验复用过来。@zhicheng-ning

[zhicheng-ning]

好棒，那我们就这么定下来。

我们可以一起补充到：https://github.com/X-lab2017/open-research/blob/main/OpenReading/README.md

正好也借此机会把 X-lab 官网也弄下，志成可以把 ONES 官网的经验复用过来。@zhicheng-ning

ONES 官网我这边没问题，直接给 markdown 内容就能正式上线了，不过之前 X-lab 官网是 @TieWay59 负责的，不清楚泰炜那边的情况

[will-ww]

好棒，那我们就这么定下来。
我们可以一起补充到：https://github.com/X-lab2017/open-research/blob/main/OpenReading/README.md
正好也借此机会把 X-lab 官网也弄下，志成可以把 ONES 官网的经验复用过来。@zhicheng-ning

ONES 官网我这边没问题，直接给 markdown 内容就能正式上线了，不过之前 X-lab 官网是 @TieWay59 负责的，不清楚泰炜那边的情况

我问了@TieWay59，他一直没有抽空做，我决定换人了，等不起了，我们一起来吧，哈哈~

[will-ww]

更新了一个文档，大家有空看看：https://github.com/X-lab2017/open-research/tree/main/OpenReading

@tyn1998

[tyn1998]

OK~

[zhicheng-ning]

@will-ww 好的，那方孝君学长之前做的 X-lab2017.github.io 仓库，我后面是需要重新选个主题作为 X-lab 官网了

[will-ww]

对的，我们全部推倒重来了，你可以任意的耍~

[will-ww]

对的，我们全部推倒重来了，你可以任意的耍~

提醒下，能复用的可以复用下。方孝君使用的是 Hugo 模板，也是一个比较主流的。具体还是看我们的需求哈。主要针对需要将我们仓库中的各类数据渲染出来，包括但不限于：

• 论文列表
• md 文件到思维导图
• 访客进行互动，利用了giscus，类似：https://opensourceway.community/
• 仓库中的论文阅读报告 md 的自动化同步
• 等等

[zhicheng-ning]

对的，我们全部推倒重来了，你可以任意的耍~

提醒下，能复用的可以复用下。方孝君使用的是 Hugo 模板，也是一个比较主流的。具体还是看我们的需求哈。主要针对需要将我们仓库中的各类数据渲染出来，包括但不限于：

• 论文列表
• md 文件到思维导图
• 访客进行互动，利用了giscus，类似：https://opensourceway.community/
• 仓库中的论文阅读报告 md 的自动化同步
• 等等

王老师您提的这些，感觉是可以 open-research 单独做一个网站(专注于论文)，而不是 xlab 实验室的官网。这样的话我们或许可以直接在 open-research 这个仓库下开一个 gh-pages 分支来进行静态网站的建设

[will-ww]

对的，我们全部推倒重来了，你可以任意的耍~

提醒下，能复用的可以复用下。方孝君使用的是 Hugo 模板，也是一个比较主流的。具体还是看我们的需求哈。主要针对需要将我们仓库中的各类数据渲染出来，包括但不限于：

• 论文列表
• md 文件到思维导图
• 访客进行互动，利用了giscus，类似：https://opensourceway.community/
• 仓库中的论文阅读报告 md 的自动化同步
• 等等

王老师您提的这些，感觉是可以 open-research 单独做一个网站(专注于论文)，而不是 xlab 实验室的官网。这样的话我们或许可以直接在 open-research 这个仓库下开一个 gh-pages 分支来进行静态网站的建设

嗯，这个想法不错，支持！