From 8ae027e26e8890575474bc8925dee040029ac0e0 Mon Sep 17 00:00:00 2001 From: Miykael_xxm Date: Mon, 8 Feb 2021 10:59:53 +0800 Subject: [PATCH] update --- CONTRIBUTING.md | 143 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 138 ++++++++++++++++++++++++++++++++++++++++++++++ config.toml | 91 ++++++++++++++++-------------- 3 files changed, 331 insertions(+), 41 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c3dae70 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,143 @@ +# Contributing + +整理 《IT技术知识开源图谱》项目是一个巨大的工程，我们希望你能够参与到这个开源项目中来，通过你的努力和贡献来修正和完善《IT技术知识开源图谱》，给开发者提供更好的学习资源。 + +你可以通过提交 Issue 和 Merge Request 的方式来参与本项目，你可以为每个路线图补充/提供知识点、学习资料，你甚至可以发起一个你感兴趣的领域路线图，通过开源的方式让大家一起来完善它。 + +# 社区治理 + +《IT技术知识开源图谱》社区由 编辑 + 专家 组成，其中编辑是由项目发起方 CODE CHINA 指定的，专家是由参与到路线图中的各个技术专家组成。 + +**编辑** - Maintainer + +编辑：编辑作为整个项目的 maintainer，负责整个《IT技术知识开源图谱》项目的日常维护工作，包括但不限于： + +- 项目的 Issue 处理 +- 更新维护图谱项目 +- 邀请/添加专家 + +> 注：编辑由项目发起方 CODE CHINA 指定，暂不接受社区成员申请。 + +**专家组** - Developer + +专家组：专家组作为整个项目的 co-member，负责某个/某几个《IT技术知识开源图谱》项目的内容建设，包括但不限于： + +- 特定路线图项目的 Issue 处理 +- 查看并 Review 特定路线图中的 Merge Request +- 参与专家组新成员投票，决定社区成员从 Reporter 提升为 Developer + +> 注：专家组成员至少需要在一个路线图中提交过 Merge Request 并被接受合并到主分支 + +**社区成员** - Reporter + +社区成员：社区成员指所有为《IT技术知识开源图谱》项目做出过贡献的用户，贡献内容不限于： + +1. 通过 Issue 提交新的知识点 +2. 通过 Issue 补充知识点的学习资料 +3. 通过 Merge Request 提交新的知识点 +4. 通过 Merge Request 补充知识点的学习资料 +5. 通过 Merge Request 优化路线图知识结构 +6. 通过 Issue / Merge Request 发起新的路线图 + +> 注：社区成员至少需要在一个路线图中提交过 Merge Request 并被接受合并到主分支，且在专家组新成员投票中获得 50% 以上的赞同票才可以提升专家组成员 +## 常见问题 + +> **1. 现在都有哪些路线图？** + +答：目前我们已经发起了**前端**、**后端**、**DevOps**等13个路线图，你可以在下方或《IT技术知识开源图谱》 Pages 中查看到全部路线图的信息，路线图也会持续更新： + +- [前端](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [后端](https://codechina.gitcode.host/developer-roadmap/backend/intro/) +- [Devops](https://codechina.gitcode.host/developer-roadmap/devops/intro/) +- [测试](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [安全](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [云原生](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [AI](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [音视频](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [区块链](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [鸿蒙OS](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [Python](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [Go](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- [Rust](https://codechina.gitcode.host/developer-roadmap/frontend/intro/) +- 持续更新中… + +> **2. 我怎么通过提交 Issue 来贡献内容？** + +答：如果你正好之前写过某个路线图中知识点相关的内容（博客文章、代码项目、代码片等），又或者你在学习过程中找到过一些非常不错的学习资料，并且你认为会对其他开发者学习该路线图中的内容有所帮助，你就可以通过 Issue 来进行提交。 + +我们在每个学习路线图中都创建了一个 Issue 模板用来指导你如何提交相应的内容，按照 Issue 模板中的内容提交即可，以下是 Python 项目中的 Issue 模板示例： + +```markdown +## 贡献类型 + +- [x] 补充学习资料 +- [ ] 补充知识点 + +> 填写说明：在对应类型的中括号/方括号中填上`x` 即可 + +## 所属知识点 + +- Python 中阶 + - Web 应用开发 + - Web 开发基础知识 + +> 填写说明： 初阶/中阶/高阶 >> 一级知识点 >> 二级知识点 （依次类推） + +## 补充内容 + +- [Web前端基础知识整理（一）](https://blog.csdn.net/hxy19971101/article/details/93383336) +- [Web前端基础知识整理（二）](https://blog.csdn.net/hxy19971101/article/details/93383336) + +> 填写说明：填写补充知识点的名称或学习资料名称+链接，如果有多个知识点或学习资料补充，在补充内容中依次提交即可 +``` + +> **3. 我怎么通过提交 Merge Request 来贡献内容？** + +答：除了 Issue 的方式外，你也可以通过 Merge Request(合并请求) 的方式来向我们提交新的知识点、补充学习资料，你甚至可以调整/优化学习路线图中的知识点结构，帮助开发者更好的理解路线图中的内容。 + +像我们提交 Merge Request 的方式，你需要： + +1. Fork 某个学习路线项目 +2. 在 Fork 的项目中进行调整，可以是提交新的知识点、补充学习资料、调整/优化知识结构等 +3. 提交更新，并向源仓库发起 Merge Request(合并请求) + +更多关于 Merge Request(合并请求) 的内容请参考 [从 Fork 项目创建合并请求](https://codechina.csdn.net/codechina/help-docs/-/wikis/docs/user/project/merge-request/create-merge-request#%E4%BB%8E-fork-%E9%A1%B9%E7%9B%AE%E6%96%B0%E5%BB%BA%E5%90%88%E5%B9%B6%E8%AF%B7%E6%B1%82) + +> **4. 我怎么发起一个新的路线图？** + +答：如果你想发起一个新的路线图，请参考目前已经发起的路线图项目，整理好路线图中的知识点、学习资料，并在当前项目中通过提交 Issue 或 Merge Request(合并请求) 的方式告知我们。 + + +**我们会尽快处理你提交的 Issue 或 Merge Request，如果需要帮助请联系【周翔 E-mail：zhouxiang@csdn.net】。** + + +## 为什么一定要贡献代码（内容）？ + +贡献代码（内容）可以避免你碰到以下麻烦： + +1.你在《IT技术知识开源图谱》上更改的代码（内容）其他人看不到，不能帮你发现 Bug，更不可能帮你修复 Bug 甚至优化代码（内容） +2.作者和其它贡献者可能不兼容你更改的代码（内容），导致你的项目在迭代 《IT技术知识开源图谱》 版本后在内容上出错 +3.你需要自己维护你的代码（内容），每次迭代 《IT技术知识开源图谱》版本时，你都需要下载《IT技术知识开源图谱》 新代码（内容）再合并你自己的更改 + +所以为了让你自己的更改始终能跟上项目版本，得到他人给予的可靠且持续的维护，强烈建议 提交 Merge Request 来贡献代码（内容）。 + + +## 开源版使用须知 + +1.允许用于个人学习、毕业设计、教学案例、公益事业 +2.如果商用必须保留版权信息，请自觉遵守 +3.禁止将本项目的代码和资源进行任何形式的出售，产生的一切任何后果责任由侵权者自负 + + +## 版权风险 + +不得发布未经个人/机构授权的著作 、资料、教程等造成版权侵权。包含但不限于以下场景： +- 标题/内容 带有软件破解含义，讲解破解流程等、提供破解工具等； +- 发布未经他人授权书籍目录、内容、相关资料、源码、下载链接等； +- 发布未经其他网站/机构授权的 资料、教程 、影评、剧透等； +- 发布 爬取付费内容、个人隐私、国家级网站内容等。 + + +## 版权和许可证 + +《IT技术知识开源图谱》由知识共享-署名-非商业性-相同方式共享(CC-BY-NC-SA) LICENSE 提供 \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5e2da5 --- /dev/null +++ b/README.md @@ -0,0 +1,138 @@ +# 项目背景 + +本项目是CSDN在编辑部协同IT领域具有技术影响力的知名企业和专家，共同打造的13个当前热门技术领域的技术知识点及相关学习资源，最终CSDN编辑进行了编辑汇总，最终制作成13张知识图谱及成长路线。通过这些知识图谱绘和成长路线，我们不难发现，作为一名IT工程师是多么不易，要面对日积月累的新技术，每门新技术都需要掌握规模庞大的知识点。 + +# 项目目的 + +本着**开源精神**， 我们决定把此项目开源， 以达到以下目的： + +1. 让更多的工程师通过一张图看到他所在的技术领域的视觉全貌， 享受并热爱自己的技术领域 +2. 让更多的专家、IT工程师能在相关的知识点下，贡献更多的学习资源，以便大家系统化的学习，甚至相互交流 +3. 产生更多的技术领域的只是图谱和进阶路线，与万千技术人共成长。 + + +本项目旨在大家一起贡献，一起学习，所有的贡献者都会作为出品人记录在案，欢迎大家一起贡献，具体贡献规则见[如何贡献](CONTRIBUTING.md) + + +# 技术专家 + +唐刚 Rust中文社区联合发起人 + +# 环境准备 + +本仓库基于 `HUGO` 模板搭建，可以在本地直接运行该项目，你可以通过以下命令安装 `HUGO`环境： + +1. 安装 `HUGO` + +```bash +# 通过 homebrew 安装(macOS / Linux) +brew install hugo +# 通过 MacPorts 安装(macOS) +port install hugo +# 通过 Chocolatey 安装(Windows) +choco install hugo -confirm +# 安装 Sass/SCSS 增强版 HUGO (Windows) +choco install hugo-extended -confirm +``` + +更多关于`HUGO`的安装内容可以参考[HUGO 官方文档](https://gohugo.io/getting-started/installing/) + +2. 安装完成后可以通过 `hugo version` 确认是否安装成功 + +```bash +➜ ~ hugo version +Hugo Static Site Generator v0.78.0-FD62817B/extended darwin/amd64 BuildDate: 2020-11-03T13:20:38Z +``` +## 目录结构 + +本仓库目录结构如下： + +``` +-- .gitlab + |-- issue_templates + |-- merge_request_templates +-- archetypes +-- content + |-- junior + |-- intermediate + |-- senior +-- data +-- layout +-- resources +-- static + |-- images +-- themes + |-- dot + |-- hugo-theme-pdf-js +-- config.toml +-- CONTRIBUTING.md +-- README.md +``` + +### 内容部分说明 + + `content` 为 Markdown 格式内容部分，`junior`,`intermediate`,`senior`分别对应 初阶、中阶、高阶部分的内容 + +#### _index.md 说明 + +每个目录下会有一个 `_index.md` 文件，用于描述每个部分的内容，其中`type`,`weight`这2个参数说明如下： + +- `type`,`_index.md`的 `type` 需要设置为 `docs`，这样才能在首页显示 +- `weight`, `weight`用于控制`type`都为`docs`的排序，即`junior`,`intermediate`,`senior`三者的排序 + +#### *.md 说明 + +除 `_index.md` 外，其余的 markdown 文件均不需要配置 `type` 参数，但仍需要配置 `weight` 参数，用于同一目录下的 md 内容排序。 + +markdown 内容的建议规则如下： + +- 每个 markdown 文件是一个一级知识点 +- 二级知识点、三级知识点在 markdown 中用列表的形式展开 +- 如果有相应的学习资料，可以放在每个知识点的 markdown 中；也可以将所有知识点单独作为最后一个 markdown 内容单独呈现 + + +### config.toml 配置说明 + +`config.toml` 是 `HUGO` 项目的配置文件，相关参数说明如下： + +- `baseURL` 是项目在 Pages 服务器上的存放目录 +- `title` 是项目的 Title +- `primary_color` 是项目的 主色调 + +更详细的介绍请参考 [HUGO 模板使用](https://codechina.csdn.net/codechina/help-docs/-/wikis/docs/user/project/pages/hugo) + +## 本地运行项目 + +在完成 **环境准备** 以及熟悉 **目录结构** 后，你可以开始在本地运行该项目，并可以实时在本地预览编辑、修改。 + +### build 项目 + +在项目目录下运行 `hugo serve -D` 即可 + +```bash +➜ ~ cd intro +➜ ~ hugo serve -D +Start building sites … + + | ZH +-------------------+----- + Pages | 28 + Paginator pages | 0 + Non-page files | 0 + Static files | 4 + Processed images | 0 + Aliases | 6 + Sitemaps | 1 + Cleaned | 0 + +Built in 42 ms +Watching for changes in ~/intro/{archetypes,content,data,layouts,static,themes} +Watching for config changes in ~/intro/config.toml +Environment: "development" +Serving pages from memory +Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender +Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) +Press Ctrl+C to stop +``` + +运行完成后即可访问 `http://localhost:1313/` 实时预览当前项目 \ No newline at end of file diff --git a/config.toml b/config.toml index eb00d04..a33b3ef 100644 --- a/config.toml +++ b/config.toml @@ -73,83 +73,92 @@ placeholder = "输入关键词" name = "Rust 语言" url = "/intro" weight = 2 + + # Dropdown menu [[menu.main]] weight = 5 -name = "成长路线图" +name = "路线图" +url = "htpps://dev-roadmap.gitcode.host/" hasChildren = true [[menu.main]] - parent = "成长路线图" - name = "前端开发路线图" + parent = "路线图" + name = "前端技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/frontend/intro/" - weight = 1 + weight = 4 [[menu.main]] - parent = "成长路线图" - name = "后端开发路线图" + parent = "路线图" + name = "后端技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/backend/intro/" - weight = 2 + weight = 13 [[menu.main]] - parent = "成长路线图" - name = "DevOps 路线图" + parent = "路线图" + name = "DevOps 技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/devops/intro/" - weight = 3 + weight = 5 [[menu.main]] - parent = "成长路线图" - name = "测试路线图" + parent = "路线图" + name = "测试技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/test/intro/" - weight = 4 + weight = 6 [[menu.main]] - parent = "成长路线图" - name = "安全技术路线图" + parent = "路线图" + name = "安全技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/security/intro/" - weight = 5 + weight = 7 [[menu.main]] - parent = "成长路线图" - name = "云原生路线图" + parent = "路线图" + name = "云原生技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/cloud-native/intro/" - weight = 6 - - [[menu.main]] - parent = "成长路线图" - name = "AI 路线图" - url = "https://codechina.gitcode.host/developer-roadmap/ai/intro/" - weight = 7 - + weight = 8 + [[menu.main]] - parent = "成长路线图" - name = "音视频路线图" + parent = "路线图" + name = "音视频技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/av/intro/" - weight = 8 + weight = 9 [[menu.main]] - parent = "成长路线图" - name = "区块链路线图" + parent = "路线图" + name = "区块链技术学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/blockchain/intro/" - weight = 9 + weight = 10 [[menu.main]] - parent = "成长路线图" - name = "鸿蒙OS路线图" + parent = "路线图" + name = "HarmonyOS 开发学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/harmonyos/intro/" - weight = 10 + weight = 11 [[menu.main]] - parent = "成长路线图" - name = "Python 路线图" + parent = "路线图" + name = "Python 学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/python/intro/" - weight = 11 + weight = 1 [[menu.main]] - parent = "成长路线图" - name = "Go 路线图" + parent = "路线图" + name = "Go 学习路线图" url = "https://codechina.gitcode.host/developer-roadmap/go/intro/" - weight = 12 + weight = 2 + + [[menu.main]] + parent = "路线图" + name = "音视频技术学习路线图" + url = "https://codechina.gitcode.host/developer-roadmap/go/intro/" + weight = 10 + + [[menu.main]] + parent = "路线图" + name = "Rust 学习路线图" + url = "https://codechina.gitcode.host/developer-roadmap/rust/intro/" + weight = 3 [[menu.main]] name = "CODE CHINA" -- GitLab