diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..1ef44ee Binary files /dev/null and b/.DS_Store differ diff --git a/.cache/plugin/git-committers/page-authors.json b/.cache/plugin/git-committers/page-authors.json index 9066a82..347ea86 100644 --- a/.cache/plugin/git-committers/page-authors.json +++ b/.cache/plugin/git-committers/page-authors.json @@ -1 +1 @@ -{"cache_date": "2024-07-29", "page_authors": {"docs/blog/index.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/blog/posts/update2024.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_1/chapter_1_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_1/chapter_1_2.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_1/chapter_1_3.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_2/chapter_2_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_3/chapter_3_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_4/chapter_4_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_10/chapter_10_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_11/chapter_11_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_12/chapter_12_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_13/chapter_13_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_14/chapter_14_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_15/chapter_15_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_5/chapter_5_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_6/chapter_6_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_7/chapter_7_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_8/chapter_8_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_9/chapter_9_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}}} \ No newline at end of file +{"cache_date": "2024-07-30", "page_authors": {"docs/blog/index.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/blog/posts/update2024.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_1/chapter_1_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_1/chapter_1_2.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_1/chapter_1_3.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_2/chapter_2_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_3/chapter_3_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_4/chapter_4_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_10/chapter_10_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_11/chapter_11_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_12/chapter_12_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_13/chapter_13_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_14/chapter_14_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_15/chapter_15_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_5/chapter_5_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_6/chapter_6_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_7/chapter_7_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_8/chapter_8_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}, "docs/textbook/chapter_9/chapter_9_1.md": {"last_commit_date": "2024-07-23", "authors": [{"login": "wangyantong2000", "name": "wangyantong2000", "url": "https://github.com/wangyantong2000", "avatar": "https://avatars.githubusercontent.com/u/135088663?v=4"}]}}} \ No newline at end of file diff --git a/README.md b/README.md index 0eb0d31..7ad09de 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,52 @@ - +# 贡献流程 +> 为了更好地管理仓库，我们建议贡献者通过Fork的方式进行修改，然后提交Pull Request以完成贡献。 +## 贡献步骤 +1. 克隆仓库 + 1. Fork本仓库到自己的GitHub账号 + 2. 也可以页面中的点击“编辑图标”，如果遇到“需要 Fork 此仓库”的提示，请同意该操作。 +
+ +
+ 3. 克隆自己Fork的仓库到本地 +2. 创建分支 + 1. 在开始之前，为你的贡献创建一个新的分支 + `git checkout -b 分支名字` +3. 开发和测试 + 1. 在文件目录`docs/textbook`下的文件夹中找到所需要修改的章节以及相应的Markdown文件，修改内容 + 2. 如果是添加新的章节和内容，在`docs/textbook`下创建新的文件夹或相应的文件夹中，创建新的`.md`文件，撰写您的内容。 + 3. 如果是添加了新的`.md`文件的方式，或者想对书籍的目录名称进行修改，找到`mkdocs.yml`文件中的nav部分，模仿下面的模版，添加相应的内容或修改 + ``` + nav: + - 首页: index.md + - 教材: + - 开源软件通识：知识体系指南: + - 第 1 章 开源知识体系: + - 1.1 背景与目标: textbook/chapter_1/chapter_1_1. md + - 1.2 知识体系与框架: textbook/chapter_1/ chapter_1_2.md + - 1.3 本书组织与结构: textbook/chapter_1/ chapter_1_3.md + ``` + 4. 效果测试。如果需要对您的修改效果进行实时查看，请参考如下步骤： + 1. 本文档网站基于`MkDocs`进行构建，使用`Material for MkDocs`主题。首先要确保您的相关环境是否安装，若没安装可以参考下面如下语句： + ``` + pip install mkdocs-material + ``` + 2. MkDocs包含一个试试预览的服务，所有可以在撰写文档的过程中进行实时预览。当文档修改保存后，这个服务会自动重建整个网站的文档。使用以下命令启动： + ``` + mkdocs serve + ``` + 浏览器打开 [localhost:8000](localhost:8000) ，应该就能看到类似下图所示的内容： +
+ +
+4. 提交更改 + 1. 将本地所做更改`commit` + 2. `push`至远程仓库。 +5. 创建`Pull Request` + 1. 在Github仓库网页中创建`Pull Request` + 2. 项目维护者将审核你的`Pull Request`，一旦你的贡献通过审查，它将被合并到主分支在。合并到主分支后，仓库的`workflow`会自动更新部署网站，在等待几十秒后，如图所示后，刷新网站，即可看到网站更新内容 +
+ +
\ No newline at end of file diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 0000000..6f16bd2 Binary files /dev/null and b/docs/.DS_Store differ diff --git a/docs/assets/.DS_Store b/docs/assets/.DS_Store new file mode 100644 index 0000000..6de4957 Binary files /dev/null and b/docs/assets/.DS_Store differ diff --git a/docs/assets/img/.DS_Store b/docs/assets/img/.DS_Store new file mode 100644 index 0000000..a66690e Binary files /dev/null and b/docs/assets/img/.DS_Store differ diff --git a/docs/assets/img/edit.png b/docs/assets/img/edit.png new file mode 100644 index 0000000..38e197c Binary files /dev/null and b/docs/assets/img/edit.png differ diff --git a/docs/assets/img/snapshot.png b/docs/assets/img/snapshot.png new file mode 100644 index 0000000..d0278c5 Binary files /dev/null and b/docs/assets/img/snapshot.png differ diff --git a/docs/assets/img/workflow.png b/docs/assets/img/workflow.png new file mode 100644 index 0000000..3e06668 Binary files /dev/null and b/docs/assets/img/workflow.png differ diff --git a/mkdocs.yml b/mkdocs.yml index b4a58c8..cbc9ddf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -78,7 +78,7 @@ markdown_extensions: extra: alternate: - name: 简体中文 - link: / + link: /oss101-bok/ lang: zh generator: false social: