Browse Source

doc: 添加教育学习课程的文档 (#1)

LoGin 7 months ago
parent
commit
09a08014ca

+ 21 - 1
README.md

@@ -1 +1,21 @@
-# mentorship
+# Mentorship
+
+Hi~这里是DragonOS社区导师制仓库。
+
+## 学习路线
+
+以下是标准的学习路线:
+
+1. 学会Rust语言(可参考[教育学习课程]提供的资料)
+2. 完成1-2项源码阅读任务([教育学习课程])
+3. 解决简单issue
+4. 参与[PBL],完成较大的功能组件的开发
+5. 成功融入社区开发.
+
+## 我该如何选择导师?
+
+这是[教育学习课程-导师名单];对于[PBL],导师信息在每个project的描述文档内。
+
+[PBL]: /project-based-mentorship/README.md
+[教育学习课程]: /educational-learning-courses/README.md
+[教育学习课程-导师名单]: /educational-learning-courses/mentors.md

+ 11 - 0
educational-learning-courses/00-contents.md

@@ -0,0 +1,11 @@
+# 目录
+
+## 通用信息
+
+- [导师名单](mentors.md)
+- [任务文档模版](task-template.md)
+- [Rust语言学习](01-rust-lang.md)
+
+## 源码阅读任务
+
+// TODO 待添加

+ 1 - 0
educational-learning-courses/01-rust-lang.md

@@ -0,0 +1 @@
+# Rust语言学习

+ 43 - 0
educational-learning-courses/README.md

@@ -0,0 +1,43 @@
+# 教育学习课程
+
+## 目标
+
+教育学习课程为“想要加入DragonOS社区,但对项目仍不熟悉”的同学而设计。
+
+## 课程目录
+
+请参阅[教育学习课程-目录]
+
+## 学习路线
+
+### 语言学习
+
+Rust语言作为DragonOS社区最主要的开发语言,在开始开发之前,您需要掌握它!
+请参阅[01-Rust语言学习]这篇文章,获取您所需的学习资料
+
+
+
+### 阅读源码
+
+在[教育学习课程-目录]中,列出了一些源码阅读任务,您可以尝试从这些源码阅读任务开始。也可以在[导师]页面联系社区导师,让他们给你一些源码阅读任务。
+
+## 导师指南
+
+- 导师在发布源码阅读任务给学员时,需要按照[模版](task-template.md)填写任务书,并发布到[mentorship仓库]!
+- 导师需要让学员在任务要求的最长时间范围内(不超过21天),将源码阅读笔记/源码分析文档/性能分析文档等文档,按照模版要求,发布在社区论坛的“教育学习课程”版块。
+- 导师的其余职责请参阅[DragonOS社区导师指南]。
+- 导师行为受[DragonOS社区行为准则]约束。
+
+
+## 学员指南
+
+- 学员需要认真参与教育学习课程。毕竟每个人的时间都是有限的,如果由于不认真参与且半途而废,其实是浪费了导师有限的时间。
+- 学员需要在任务限定的时间内,将结项要求的文档,按照模版要求,发布到社区论坛的“教育学习课程”版块。
+- 学员行为受[DragonOS社区行为准则]约束。
+
+[01-Rust语言学习]: /educational-learning-courses/01-rust-lang.md
+[教育学习课程-目录]: /00-contents.md
+[mentorship仓库]: https://github.com/DragonOS-Community/mentorship.md
+[DragonOS社区导师指南]: https://community.dragonos.org/mentorship/mentor-guide.html
+[DragonOS社区行为准则]: https://community.dragonos.org/contributors/code_of_conduct.html
+

+ 3 - 0
educational-learning-courses/mentors.md

@@ -0,0 +1,3 @@
+# 导师名单
+
+// TODO 待添加

+ 38 - 0
educational-learning-courses/task-template.md

@@ -0,0 +1,38 @@
+# 模版
+
+这里是教育学习课程的任务书及结项文档的模版,请导师、学员按照模版提交内容~
+
+# 任务书模版【任务标题】
+
+## 信息
+
+- 任务ID(按照添加任务的PR的id来填写,比如#233)
+- 导师名单
+  - @导师1:SIG名称,联系方式
+  - @导师2:SIG名称,联系方式
+- 难度:星级(1-5)
+- 辅导时间:天数,(注意,社区要求最长不超过21天)
+- 涉及的代码仓库
+
+
+## 任务的简介
+
+这里用不超过200字来描述这个源码阅读任务
+
+## 任务目标
+
+这里分点描述该任务的学习目标,也就是:
+- 涉及源码的哪些方面
+- 学员能够从中学到什么
+- 学员应当完成哪些思考任务
+- 学员需要提交哪些材料
+
+
+# 学员结项文档模版
+
+学员在发帖方式展示结项文档时,需要在文档首部添加以下内容:
+
+- 任务ID(以及对应的github文档的链接)
+- 阅读的代码仓库链接
+- 阅读的代码的git版本号(那个哈希值)
+- 导师的github首页链接

+ 3 - 0
project-based-mentorship/README.md

@@ -0,0 +1,3 @@
+# PBL 基于项目的学习
+
+// todo