Initial commit

Update README.md

Add some tasks in the Assignment.md

Add different stages in understanding oss

make stages as bullets

Add some secondary bullets for these stages

adjust my outline

add some introduction to open source and git basic knowledge

rename the folder

Add outline for Git Basics

add more modules

remove .DS_Store and mark it in .gitignore

docs: improve README outline

Signed-off-by: Zhenchen Wang <[email protected]>

docs: improve outline details

Signed-off-by: Zhenchen Wang <[email protected]>

feat: add mkdocs framework and improve outline

Signed-off-by: Zhenchen Wang <[email protected]>

feat: add GitHub Actions workflow for MkDocs

docs: refactored docs' file structure

Add "为RustSBI贡献" in `Contributing to RustSBI`

Refs: https://github.com/rustsbi/slides/blob/main/2025/reports/%E4%B8%BA%20RustSBI%20%E8%B4%A1%E7%8C%AE.md
Signed-off-by: DongQing <[email protected]>

fix: fix the index level

Signed-off-by: Zhenchen Wang <[email protected]>

feat: edited site theme

fix: gh-page action delete CNAME

feat: Add Git training content, Markdown extensions, and platform overview with basic operations.

feat: Create initial file structure

feat: Add multiple Markdown extensions to enhance documentation

feat: Add platform overview and basic operations guide

feat: 添加Git训练营章节及相关内容

创建文件

feat: 添加多个Markdown扩展以增强文档功能

feat: 添加代码托管平台简介及基本操作指南

feat: replace github page source from branch to action

fix: remove pull_request trigger

ci: add build,lint,lint-all

Signed-off-by: Jianuo Kuang <[email protected]>

fix: add .zhlintrc

Signed-off-by: Jianuo Kuang <[email protected]>

fix: change some trigers in build ,lint and lint-all

Signed-off-by: Jianuo Kuang <[email protected]>

fix: Correct incorrect configuration paths

feat: Update code hosting platform section with platform definition and analogy, and optimize feature descriptions

docs: Update code hosting platform section, improve descriptions and add GitLink platform information

feat: Add .caption class styles, adjust font size and color, and optimize text alignment

doc: Update code hosting platform documentation, add registration process and feature overview,

feat: Add markdownlint configuration file and adjust rules to align with project requirements

doc: Update practice documentation with detailed steps for creating and managing repositories

docs: add detailed information to ch1/index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Update index.md

Add more detailed information to the docs/ch1/index.md

refactor: refactor outline and docs level

Signed-off-by: Zhenchen Wang <[email protected]>

Feat:Updata Open Source License Guide and improve README

docs: add git introduction and commit message docs

Signed-off-by: Zhenchen Wang <[email protected]>

subsec1,2,3

docs:Add git basic configuration and staging area

Signed-off-by: lurenjia1213 <[email protected]>

docs: Completed ch1/why-oss section

docs: Completed ch1_why-oss section

docs: Completed ch1/why-oss section

docs add 4.1.3.1 and 4.1.3.2 and 4.1.3.3

docs add 4.1.3.1 and 4.1.3.2 and 4.1.3.3 new

docs: complete ch3/sec1/subsec3 1-rebase-merge and 2-control-process and 3-help-open

Update mkdocs.yml

docs: correct spelling of CHANGELOG

Author: mudongliang

.github/workflows/.zhlintrc

@@ -0,0 +1,6 @@
+{
+  "preset": "default",
+  "rules": {
+    "halfwidthPunctuation": "（），。、"
+  }
+}

.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: build
+
+on:
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.13'
+
+    - name: Install dependencies
+      run: pip3 install -r requirements.txt
+      
+    - name: Build docs
+      run: |
+        mkdocs -v build

.github/workflows/deploy_ghpage.yml

@@ -0,0 +1,44 @@
+name: Deploy MkDocs to GitHub Pages
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
+          cache: 'pip'
+      - name: Install Python Dependencies
+        run: pip install -r requirements.txt
+      - name: build site
+        run: mkdocs build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './site'
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/lint-all.yml

@@ -0,0 +1,50 @@
+name: Lint All
+
+on:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install zhlint
+        run: yarn global add zhlint
+
+      - name: Lint all Markdown files
+        run: |
+          mkdir -p linted_output
+          file_list="linted_output/file_list.txt"
+          linted_failed_file=$(mktemp)
+          echo 0 > "$linted_failed_file"
+          find . -type f -name '*.md' | while read -r file; do
+            set +e
+            zhlint --config "$GITHUB_WORKSPACE"/.github/workflows/.zhlintrc "$file"
+            if [ $? -ne 0 ]; then
+              echo 1 > "$linted_failed_file"
+              echo "$file" >> "$file_list"
+              output_file="linted_output/report_and_suggested_fixes/$file"
+              mkdir -p "$(dirname "$output_file")"
+              zhlint --config "$GITHUB_WORKSPACE"/.github/workflows/.zhlintrc "$file" --output="$output_file" > "$output_file.log" 2>&1
+            fi
+            set -e
+          done
+          linted_failed=$(cat "$linted_failed_file")
+          rm "$linted_failed_file"
+          echo "linted_failed=$linted_failed" >> "$GITHUB_ENV"
+
+      - name: Upload linted Markdown
+        uses: actions/upload-artifact@v4
+        with:
+          name: linted-markdown
+          path: linted_output/
+
+      - name: Check lint errors
+        run: |
+          set -e
+          if [ "${{ env.linted_failed }}" -ne 0 ]; then
+            echo "Linting errors found. Please check the reports and suggested fixes in uploaded artifact."
+            exit 1
+          fi

.github/workflows/lint.yml

@@ -0,0 +1,63 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+    paths:
+      - '**/*.md' # Only run on Markdown file changes
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install zhlint
+        run: yarn global add zhlint
+
+      - name: Get changed Markdown files
+        id: changed-files
+        uses: tj-actions/changed-files@v45
+        with:
+          files: '**/*.md'
+
+      - name: Lint Markdown files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
+        run: |
+          mkdir -p linted_output
+          file_list="linted_output/file_list.txt"
+          linted_failed=0
+          for file in ${{ env.ALL_CHANGED_FILES }}; do
+            set +e
+            zhlint --config "$GITHUB_WORKSPACE"/.github/workflows/.zhlintrc "$file"
+            if [ $? -ne 0 ]; then
+              linted_failed=1
+              echo "$file" >> "$file_list"
+              output_file="linted_output/report_and_suggested_fixes/$file"
+              mkdir -p "$(dirname "$output_file")"
+              zhlint --config "$GITHUB_WORKSPACE"/.github/workflows/.zhlintrc "$file" --output="$output_file" > "$output_file.log" 2>&1
+            fi
+            set -e
+          done
+          echo "linted_failed=$linted_failed" >> "$GITHUB_ENV"
+
+      - name: Upload Linted Markdown
+        uses: actions/upload-artifact@v4
+        with:
+          name: linted-markdown
+          path: linted_output/
+
+      - name: Check lint errors
+        run: |
+          set -e
+          if [ "${{ env.linted_failed }}" -ne 0 ]; then
+            echo "Linting errors found. Please check the reports and suggested fixes in the job [Lint Markdown files]. Otherwise, you can download report files in uploaded artifact."
+            exit 1
+          fi

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+site/

.markdownlint.json

@@ -0,0 +1,5 @@
+{
+    "MD046": false,          
+    "MD013": false,          
+    "default": true
+  }

Assignment.md

@@ -0,0 +1,4 @@
+- HCTT 文档翻译（自由选择一篇已收集的英文文档），按照 Wiki 中要求的流程完成 “翻译申请”，“翻译提交” 等操作。
+- 选择 Git 游戏学习方式（https://learngitbranching.js.org），当然，这个游戏也是开源在 Github 上的项目，大家也可以选择向这个仓库进行开源贡献。
+- 在 Github/Gitee 上创新一个账号（如果没有的话），并使用工具提交自己的第一个 commit，PR。
+- 在 pwn.hust.college 平台 <https://pwn.cse.hust.edu.cn> 中完成 “Linux/Unix 基本命令使用” 道馆（**待创建**）。

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 华中科技大学开放原子开源俱乐部
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,136 @@
+# 开源软件通识课程
+
+欢迎大家来到华科开放原子开源俱乐部的《开源软件通识课程》内部培训课程。本课程将秉持 “以开源方式来建设开源课程” 的指导方针，带同学们一起畅游开源软件的海洋。
+
+带领俱乐部成员认识开源软件经历如下的不同阶段：
+
+---
+
+### **S0：无意识使用阶段**
+
+> **目标：**认识到开源已融入生活，了解自己日常使用的开源软件。
+
+* **开源无处不在**
+  * 举例说明：现代科技中广泛应用的开源软件，例如 Android 系统（基于 Linux），浏览器（如 Chrome 和 Firefox），办公工具（如 LibreOffice），以及其他开发工具（如 Git、Vim、Node.js）。
+  * 说明开源如何成为现代技术的基石：手机、服务器、云计算、大数据、人工智能等领域。
+* **参考任务：**
+  * 列举自己日常使用的一些开源软件，并尝试查找它们的开源主页或仓库。
+  * 调研一个开源项目的背景，了解它在行业中的应用（如 Linux、Kubernetes）。
+
+---
+
+### **S1：了解开源阶段**
+
+> **目标：**初步了解开源的概念、历史、许可证及其影响，培养开源安全意识。
+
+* **开源是什么？**
+  * **开源是一种软件类型：**定义开源软件，与闭源软件对比。
+  * **开源是一种软件开发方式：**举例开源协作的特点，如社区贡献、代码开放。
+  * **开源是一种协作与创新模式：**讲解如何通过开源实现跨组织协作和技术创新。
+  * **开源是一种产业生态：**开源如何驱动技术演进和形成商业生态（如红帽的成功案例）。
+* **开源历史**
+  * 时间线和重要节点：Unix -> GNU -> Linux -> Git -> Github。
+  * 自由软件运动与 Richard Stallman 的贡献。
+  * 开源运动的兴起与 Open Source Initiative (OSI)。
+* **开源许可证**
+  * 介绍许可证的作用和开源定义（Open Source Definition）。
+  * **常见开源许可证：**
+    * Copyleft：GPL、AGPL 等。
+    * Permissive：MIT、Apache-2.0、BSD。
+    * 禁用场景：禁止与专利冲突等。
+  * **如何选择许可证？**举例如何根据项目需求选择适当的许可证。
+* **开源安全**
+  * 开源软件供应链安全：了解漏洞传播机制（如 Log4j 漏洞案例）。
+  * 安全最佳实践：开源软件的审计和管理（如使用 Dependabot）。
+* **参考任务：**
+  1. 创建 Github 帐号，初始化一个简单的项目（如 README 文件）。
+  2. 为该项目选择一个开源许可证，并撰写一段文字解释选择理由。
+
+---
+
+### **S2：拥抱开源阶段**
+
+> **目标：**开始使用开源软件，初步了解开源项目的协作模式。
+
+* **开源协作模式**
+  * **如何贡献：**Issue、Pull Request、Code Review。
+  * **工具与平台：**使用 Github、Gitlab 等托管平台。
+  * **开源项目工作流：**了解从 Issue 到 PR 的完整流程。
+* **开源软件的替代方案**
+  * 举例：用 Linux 替代 Windows，用 LibreOffice 替代 Microsoft Office，用 GIMP 替代 Photoshop，用 VLC 替代商业播放器。
+  * **选择适合的发行版：**
+    * 桌面发行版：Ubuntu、Deepin、OpenEuler。
+    * 服务器发行版：CentOS Stream、Alpine。
+* **活动组织**
+  * 了解和参与开源社区活动：如 Linux 101、OpenEuler 社区活动等。
+  * 通过参与活动了解更多开源工具和资源。
+* **参考任务：**
+  1. 找到一个可以替换闭源工具的开源软件，并将其应用到日常工作中。
+  2. 记录切换开源软件的过程、问题和解决方案，撰写一篇博客分享。
+
+---
+
+### **S3：贡献开源阶段**
+
+> **目标：**学习开源基础技能并通过代码或文档的贡献实践开源。
+
+* **开源基础技能**
+  * **Git 学习：**
+    * Git 的基本操作（clone、commit、push、pull、merge 等）。
+    * Git 的原理：分支、HEAD 指针、合并冲突等概念。
+    * 进阶技能：使用 Git 提交签名、提交模板。
+  * **代码托管平台：**
+    * Github、Gitlab、Gitee 等的使用技巧。
+    * 项目管理功能：Issue、Milestone、Wiki。
+  * **如何写好一个 commit message：**
+    * Linux Kernel Patch。
+    * Conventional Commits。
+    * RustSBI 项目的 commit message 规范。
+  * **文档撰写：**
+* **计算机基础知识**
+  * The Missing Semester of Your CS Education。
+  * **不同方向的简单介绍与开源项目：**
+    * 系统开发：Linux Kernel、QEMU。
+    * Web 开发：React、Vue。
+    * 网络：WireGuard、Cilium。
+    * 数据分析：Pandas、Jupyter。
+    * 人工智能：TensorFlow、PyTorch。
+  * 找到适合自己的方向并选择活跃的开源项目。
+* **表达与交流的重要性**
+  * 如何清晰表达问题和想法。
+  * 如何有效进行跨文化交流。
+* **学会如何提问**
+  * 如何查找资料：善用 Google 和 Stack Overflow。
+  * 提问的基本规范：明确描述问题、给出复现步骤。
+* **参考任务：**
+  1. 学习使用 Git，完成一次 Fork 并提交 PR 的流程。
+  2. 选择一个开源项目，通过贡献文档或代码提交一个 PR。
+
+---
+
+### **S4：领导开源阶段**
+
+> **目标：**成为开源项目的领导者，掌握社区管理和开源治理能力。
+
+* **开源社区及其管理**
+
+  * 如何组织和维护开源社区：Code of Conduct、贡献者指南。
+  * 如何吸引和管理贡献者：鼓励多样性和贡献。
+* **开源社区安全治理**
+
+  * 如何处理安全问题（如 CVE 报告）。
+  * 如何保护社区免受恶意代码或行为影响。
+* **开源社区合规**
+
+  * 合规流程的重要性：知识产权管理、许可证合规。
+  * 如何进行开源项目的合规审计。
+* **参考任务：**
+
+  1. 创建一个开源项目，撰写清晰的 README 和贡献者指南。
+  2. 通过自己的开源项目吸引其他人贡献并管理他们的贡献。
+  3. 如果不想长期维护，可以将项目捐献到俱乐部。
+
+
+### **贡献指南**
+如果 commit 时候遇到 md 格式问题，在对应的 action run 底下会有一个 artifact，保存了所有的 log 和对应的 autofix
+commit message 中尽量不要出现中文，以及相同的 commit 可以合并成一个。