From 41bdc6f605e9f1f998703210ec007c3018a85ca0 Mon Sep 17 00:00:00 2001 From: icekylin Date: Sun, 13 Jun 2021 12:40:51 +0800 Subject: [PATCH] update --- README.md | 20 ++- code_of_conduct.md | 87 +++++++++++++ docs/.vuepress/config.js | 7 +- docs/.vuepress/public/README.md | 160 ------------------------ docs/README.md | 20 ++- docs/footer.html | 6 +- docs/{ => postscript}/about.md | 10 +- docs/{ => postscript}/contribute.md | 0 docs/postscript/contributor-covenant.md | 94 ++++++++++++++ docs/postscript/copyright.md | 42 +++++++ docs/prologue.md | 25 ++-- header.html | 10 ++ 12 files changed, 283 insertions(+), 198 deletions(-) create mode 100644 code_of_conduct.md delete mode 100644 docs/.vuepress/public/README.md rename docs/{ => postscript}/about.md (95%) rename docs/{ => postscript}/contribute.md (100%) create mode 100644 docs/postscript/contributor-covenant.md create mode 100644 docs/postscript/copyright.md diff --git a/README.md b/README.md index d8ca9f508..702f8abc1 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,16 @@ alt="百度统计" /> + + Contributor Covenant +

@@ -96,7 +106,7 @@ ## 📕 相关信息 -本指南是 [Arch Linux 安装使用教程](https://github.com/ArchLinuxStudio/ArchLinuxTutorial) 的下游文档，相比原教程，本指南进行了如下更改： +本指南派生自 [Arch Linux 安装使用教程](https://github.com/ArchLinuxStudio/ArchLinuxTutorial)，相比原教程，本指南进行了如下更改： 1. 📖 格式优化 —— 由 VuePress 驱动，相对原教程格式进行优化 2. 🎏 详细介绍 —— 对安装的细节和原理进行了更为详细的说明，知其然知其所以然 @@ -153,11 +163,15 @@ yarn docs:dev 2. 由于使用 VuePress V2 Beta 版本导致兼容性问题缺失了部分插件（评论） 3. 缺失外语翻译 +更多信息请参阅 [贡献指南](https://arch.icekylin.online/postscript/contribute.md)。 + ## 🎋 版权说明 -[![by-sa](./docs/static/svg/by-sa.svg)](http://creativecommons.org/licenses/by-sa/4.0/) +[![by-sa](./docs/static/svg/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) + +网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) 进行许可。 -网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](http://creativecommons.org/licenses/by-sa/4.0/) 进行许可。 +更多信息请参阅 [版权说明](https://arch.icekylin.online/postscript/copyright.md)。 ## ⭐ Star 历史 diff --git a/code_of_conduct.md b/code_of_conduct.md new file mode 100644 index 000000000..8e63da32a --- /dev/null +++ b/code_of_conduct.md @@ -0,0 +1,87 @@ +# 贡献者公约 + +## 我们的承诺 + +身为项目成员、贡献者、负责人，我们保证参与此社区的每个人都不受骚扰，不论其年龄、体型、身体条件、民族、性征、性别认同与表现、经验水平、教育程度、社会地位、国籍、相貌、种族、宗教信仰及性取向如何。 + +我们承诺致力于建设开放、友善、多元、包容、健康的社区环境。 + +## 我们的准则 + +有助于促进本社区积极环境的行为包括但不限于： + +- 与人为善、推己及人 +- 尊重不同的主张、观点和经历 +- 积极提出、耐心接受有益批评 +- 面对过失，承担责任、认真道歉、从中学习 +- 关注社区共同诉求，而非一己私利 + +不当行为包括但不限于： + +- 发布与性有关的言论或图像，以及任何形式的献殷勤或勾引 +- 挑衅行为、侮辱或贬损的言论、人身及政治攻击 +- 公开或私下骚扰 +- 未获明确授权擅自发布他人的资料，如地址、电子邮箱等 +- 其他有理由认定为违反职业操守的不当行为 + +## 落实之义务 + +社区负责人有责任诠释何谓“妥当行为”，并据此准则，妥善公正地认定与处置不当、威胁、冒犯及有害的行为。 + +社区负责人有权利和义务删除、编辑、拒绝违背本公约的评论（comment）、提交（commit）、代码、维基（wiki）编辑、问题（issue）等贡献。如有必要，需告知采取措施之理由。 + +## 适用范围 + +此行为标准适用于本社区全部场合，以及在其他场合代表本社区的个人。 + +代表本社区的情形包括但不限于：使用官方电子邮件与社交平台、作为指定代表参与在线或线下活动。 + +## 贯彻落实 + +如遇滥用、骚扰等不当行为，请通过 sugarkylin@foxmail.com 向纪律检查委员举报。 +纪委将迅速审议并调查全部投诉。 + +社区全体负责人有义务保密举报者信息。 + +## 指导方针 + +社区负责人将依据下列方案判断并处置违纪行为： + +### 一、督促 + +**社区影响**：用语不当、举止不符合职业道德或不受社区欢迎。 + +**处理意见**：由社区负责人予以非公开的书面警告，阐明违纪事由、解释举止如何不妥。或将要求公开道歉。 + +### 二、警告 + +**社区影响**：一起或多起事件中的违纪行为。 + +**处理意见**：警告继续违纪之后果、违纪者在特定时间内禁止与当事人往来、不得擅自与社区执法者往来，禁令涵盖社区内外、社交网络在内的一切联络。如有违反，可致封禁乃至开除。 + +### 三、封禁 + +**社区影响**：严重违纪行为，包括屡教不改。 + +**处理意见**：违纪者在特定时间内禁止与社区的任何往来或公开联络，禁止任何与当事人公开或私下往来，不得擅自与社区执法者往来。如有违反，可致开除。 + +### 四、开除 + +**社区影响**：典型违纪行为，例如屡教不改、骚扰某个人、敌对或贬低某个群体。 + +**处理意见**：无限期禁止违纪者与项目社区的一切公开往来。 + +## 来源 + +本行为标准改编自 [参与者公约][homepage] 2.0 版，可在此查阅：[https://www.contributor-covenant.org/zh-cn/version/2/0/code_of_conduct.html][v2.0] + +指导方针借鉴自 [Mozilla 纪检分级][mozilla coc]。 + +此行为标准常见问题请洽：[https://www.contributor-covenant.org/faq][faq]。 +另有诸译本：[https://www.contributor-covenant.org/translations][translations]。 + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[mozilla coc]: https://github.com/mozilla/diversity +[faq]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index cb66614ba..8d273fbad 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -240,7 +240,12 @@ gtag('config', 'G-MQRPJQK9SC');`, { isGroup: true, text: "🍰 写在后面", - children: ["/contribute.md", "/about.md"], + children: [ + "/postscript/contributor-covenant.md", + "/postscript/contribute.md", + "/postscript/copyright.md", + "/postscript/about.md", + ], }, ], sidebarDepth: 1, diff --git a/docs/.vuepress/public/README.md b/docs/.vuepress/public/README.md deleted file mode 100644 index 9a53810d0..000000000 --- a/docs/.vuepress/public/README.md +++ /dev/null @@ -1,160 +0,0 @@ -

- - arch-guide - -

- -

archlinux 简明指南

- -

- 📖 本指南包含从 archlinux - 安装、显卡驱动、日常软件配置、多媒体制作、编程等你可能需要的全部内容 -

-

❤️ 让 archlinux 成为你的常用系统吧！

- -

- - Lines of code - - - arch-guide - - - GitHub last commit - - - GitHub Repo stars - - - Gitee Repo stars - - - 百度统计 - -

- -

- 📖 阅读地址 -

- -## 🚧 文档施工中 - -## 📕 相关信息 - -本指南是 **Arch Linux 安装使用教程** 的下游文档，相比原教程，本指南进行了如下更改： - -1. 📖 格式优化 —— 由 VuePress 驱动，相对原教程格式进行优化 -2. 🎏 详细介绍 —— 对安装的细节和原理进行了更为详细的说明，知其然知其所以然 -3. 🏝️ 图文丰富 —— 增加了更多可视化内容，更加生动形象 -4. ❎ 内容和谐 —— 删除了部分不和谐的内容，如有需要请参阅原文档 -5. ✅ 实用至上 —— 遵循 arch 实用性原则，避免意识形态问题，对非自由软件更加包容 - -## 💻 本地运行 - -### Pacman - -```bash -sudo pacman -S nodejs yarn # 安装 nodejs 和 yarn -git clone https://github.com/NakanoMikuOrg/arch-guide.git -cd ./arch-guide -yarn install -yarn docs:dev -``` - -### HomeBrew - -```bash -brew install yarn # 安装 yarn -git clone https://github.com/NakanoMikuOrg/arch-guide.git -cd ./arch-guide -yarn install -yarn docs:dev -``` - -### Scoop - -```bat -scoop install nodejs # 安装 nodejs -scoop install yarn # 安装 yarn -git clone https://github.com/NakanoMikuOrg/arch-guide.git -cd ./arch-guide -yarn install -yarn docs:dev -``` - -其它系统请参阅 [Yarn 中文文档](https://yarn.bootcss.com/docs/install/) 安装 `Yarn`。 - -## 🔔 隐私提醒 - -本站使用百度统计和 Google Analytics 分析流量。访问即同意它们的隐私政策。 - -## 🌱 参与贡献 - -欢迎对指南内容以及网站源码做出贡献，也欢迎对本指南的上游文档做出贡献。 - -目前指南存在的问题包括但不限于： - -1. 文档部分格式依然未完成优化 -2. 由于使用 VuePress V2 Beta 版本导致兼容性问题缺失了部分插件（评论） -3. 缺失外语翻译 - -## 🎋 版权说明 - -[![by-sa](./static/svg/by-sa.svg)](http://creativecommons.org/licenses/by-sa/4.0/) - -网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](http://creativecommons.org/licenses/by-sa/4.0/) 进行许可。 diff --git a/docs/README.md b/docs/README.md index 161c982c0..37f55cdc4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -27,18 +27,18 @@ features: footer: '

Code licensed under MIT, documentation under CC BY-SA 4.0. Made with ❤️️ love by icekylinALL volunteers.

' footerHtml: true @@ -99,18 +99,12 @@ yarn docs:dev 2. 由于使用 VuePress V2 Beta 版本导致兼容性问题缺失了部分插件（评论） 3. 缺失外语翻译 -更多信息请参阅 [贡献指南](/contribute.md) 章节。 +更多信息请参阅 [贡献指南](/postscript/contribute.md)。 ## 🎋 版权说明 -[![by-sa](./static/svg/by-sa.svg)](http://creativecommons.org/licenses/by-sa/4.0/) +[![by-sa](./static/svg/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) -网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](http://creativecommons.org/licenses/by-sa/4.0/) 进行许可。 +网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) 进行许可。 -### 特殊说明 - -#### 字体 - -- [Segoe UI Emoji](https://docs.microsoft.com/zh-cn/typography/font-list/segoe-ui-emoji) © 2018 Microsoft Corporation. All Rights Reserved. - -更多信息请参阅 [关于指南](/about.md#版权声明) 章节。 +更多信息请参阅 [版权说明](/postscript/copyright.md)。 diff --git a/docs/footer.html b/docs/footer.html index e28ec4f71..be633ff47 100644 --- a/docs/footer.html +++ b/docs/footer.html @@ -1,17 +1,17 @@

Code licensed under MIT, documentation under CC BY-SA 4.0. Made with ❤️️ love by icekylinALL volunteers.

diff --git a/docs/about.md b/docs/postscript/about.md similarity index 95% rename from docs/about.md rename to docs/postscript/about.md index e67b41994..e267e2873 100644 --- a/docs/about.md +++ b/docs/postscript/about.md @@ -1,12 +1,8 @@ -# 关于指南 - -## 版权声明 - -## 附录 +# 附录 > 原作者对教程的补充解释以及致谢，这里原文摘录 -### 补充解释 +## 补充解释 首先说明一下和官方文档的定位区别。官方中文文档确实很全，但它的定位是官方文档，这样的话已经就需要做到事无巨细。但是这种过于详细的文档，会使得新手在一个又一个链接中迷失方向，他们更需要的是指引，而不是字典。本文的定位是指引，以及群主个人认为的当前的较好的方案。另外，官方中文文档大多翻译自英文文档，存在翻译不及时的情况。少数还有翻译有误或者含义不清的情况。 @@ -14,7 +10,7 @@ 许多人还在认为 Linux 不适合做日常使用的操作系统。说实在的，在本世纪的前十年，Linux 桌面确实不太堪用。但是现在时间已经是 2021 年后了，Linux 桌面与生态有了长足的进步。不论是办公，轻度娱乐还是编程，基本都可以满足需求。 -### 致谢 +## 致谢 最近几年，群主经历了很多事情，基本都不是什么好事。所以有了那么一丁点微小的感悟。 diff --git a/docs/contribute.md b/docs/postscript/contribute.md similarity index 100% rename from docs/contribute.md rename to docs/postscript/contribute.md diff --git a/docs/postscript/contributor-covenant.md b/docs/postscript/contributor-covenant.md new file mode 100644 index 000000000..e298ae599 --- /dev/null +++ b/docs/postscript/contributor-covenant.md @@ -0,0 +1,94 @@ +# 贡献者公约 + +

+ Contributor Covenant +

+ +## 我们的承诺 + +身为项目成员、贡献者、负责人，我们保证参与此社区的每个人都不受骚扰，不论其年龄、体型、身体条件、民族、性征、性别认同与表现、经验水平、教育程度、社会地位、国籍、相貌、种族、宗教信仰及性取向如何。 + +我们承诺致力于建设开放、友善、多元、包容、健康的社区环境。 + +## 我们的准则 + +有助于促进本社区积极环境的行为包括但不限于： + +- 与人为善、推己及人 +- 尊重不同的主张、观点和经历 +- 积极提出、耐心接受有益批评 +- 面对过失，承担责任、认真道歉、从中学习 +- 关注社区共同诉求，而非一己私利 + +不当行为包括但不限于： + +- 发布与性有关的言论或图像，以及任何形式的献殷勤或勾引 +- 挑衅行为、侮辱或贬损的言论、人身及政治攻击 +- 公开或私下骚扰 +- 未获明确授权擅自发布他人的资料，如地址、电子邮箱等 +- 其他有理由认定为违反职业操守的不当行为 + +## 落实之义务 + +社区负责人有责任诠释何谓“妥当行为”，并据此准则，妥善公正地认定与处置不当、威胁、冒犯及有害的行为。 + +社区负责人有权利和义务删除、编辑、拒绝违背本公约的评论（comment）、提交（commit）、代码、维基（wiki）编辑、问题（issue）等贡献。如有必要，需告知采取措施之理由。 + +## 适用范围 + +此行为标准适用于本社区全部场合，以及在其他场合代表本社区的个人。 + +代表本社区的情形包括但不限于：使用官方电子邮件与社交平台、作为指定代表参与在线或线下活动。 + +## 贯彻落实 + +如遇滥用、骚扰等不当行为，请通过 sugarkylin@foxmail.com 向纪律检查委员举报。 +纪委将迅速审议并调查全部投诉。 + +社区全体负责人有义务保密举报者信息。 + +## 指导方针 + +社区负责人将依据下列方案判断并处置违纪行为： + +### 一、督促 + +**社区影响**：用语不当、举止不符合职业道德或不受社区欢迎。 + +**处理意见**：由社区负责人予以非公开的书面警告，阐明违纪事由、解释举止如何不妥。或将要求公开道歉。 + +### 二、警告 + +**社区影响**：一起或多起事件中的违纪行为。 + +**处理意见**：警告继续违纪之后果、违纪者在特定时间内禁止与当事人往来、不得擅自与社区执法者往来，禁令涵盖社区内外、社交网络在内的一切联络。如有违反，可致封禁乃至开除。 + +### 三、封禁 + +**社区影响**：严重违纪行为，包括屡教不改。 + +**处理意见**：违纪者在特定时间内禁止与社区的任何往来或公开联络，禁止任何与当事人公开或私下往来，不得擅自与社区执法者往来。如有违反，可致开除。 + +### 四、开除 + +**社区影响**：典型违纪行为，例如屡教不改、骚扰某个人、敌对或贬低某个群体。 + +**处理意见**：无限期禁止违纪者与项目社区的一切公开往来。 + +## 来源 + +本行为标准改编自 [参与者公约][homepage] 2.0 版，可在此查阅： [https://www.contributor-covenant.org/zh-cn/version/2/0/code_of_conduct.html][v2.0] + +指导方针借鉴自 [Mozilla 纪检分级][mozilla coc]。 + +此行为标准常见问题请洽：[https://www.contributor-covenant.org/faq][faq]。 +另有诸译本：[https://www.contributor-covenant.org/translations][translations]。 + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[mozilla coc]: https://github.com/mozilla/diversity +[faq]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/docs/postscript/copyright.md b/docs/postscript/copyright.md new file mode 100644 index 000000000..da73da2c5 --- /dev/null +++ b/docs/postscript/copyright.md @@ -0,0 +1,42 @@ +# 版权说明 + +## 原作信息 + +本指南派生自 [Arch Linux 安装使用教程](https://github.com/ArchLinuxStudio/ArchLinuxTutorial)。 + +### 原作作者 + +- [Kagarino Kirie](https://github.com/wallena3) +- [icekylin](https://github.com/ice-kylin) +- [hibobmaster](https://github.com/hibobmaster) +- [Chumo2791](https://github.com/Chumo2791) +- [JimMoen](https://github.com/JimMoen) +- [livrth](https://github.com/livrth) +- [ConanEdogawa1](https://github.com/ConanEdogawa1) + +### 原作许可证 + +[![by-sa](../static/svg/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) + +原作采用 [知识共享署名-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) 进行许可。 + +### 特别声明 + +本作品所有观点仅代表本项目贡献者观点，**许可人不为本指南的观点、示例或任何行为背书**。 + +## 本作信息 + +[![by-sa](../static/svg/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) + +网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) 进行许可。 + +## 本作作者 + +- [icekylin](https://github.com/ice-kylin) +- [LinuXP](https://github.com/LagrangeOranges) + +## 特殊说明 + +### 字体 + +- [Segoe UI Emoji](https://docs.microsoft.com/zh-cn/typography/font-list/segoe-ui-emoji) © 2018 Microsoft Corporation. All Rights Reserved. diff --git a/docs/prologue.md b/docs/prologue.md index 0fa92a1a6..5909289a9 100644 --- a/docs/prologue.md +++ b/docs/prologue.md @@ -72,10 +72,19 @@ next: /prepare/head-on-blow.md src="https://img.shields.io/badge/Baidu-%E7%BB%9F%E8%AE%A1-blue" alt="百度统计" /> +   + + Contributor Covenant

-本指南是 [Arch Linux 安装使用教程](https://github.com/ArchLinuxStudio/ArchLinuxTutorial) 的下游文档，相比原教程，本指南进行了如下更改： +本指南派生自 [Arch Linux 安装使用教程](https://github.com/ArchLinuxStudio/ArchLinuxTutorial)，相比原教程，本指南进行了如下更改： 1. 📖 格式优化 —— 由 VuePress 驱动，相对原教程格式进行优化 2. 🎏 详细介绍 —— 对安装的细节和原理进行了更为详细的说明，知其然知其所以然 @@ -140,18 +149,12 @@ yarn docs:dev 2. 由于使用 VuePress V2 Beta 版本导致兼容性问题缺失了部分插件（评论） 3. 缺失外语翻译 -更多信息请参阅 [贡献指南](/contribute.md) 章节。 +更多信息请参阅 [贡献指南](/postscript/contribute.md)。 ## 🎋 版权说明 -[![by-sa](./static/svg/by-sa.svg)](http://creativecommons.org/licenses/by-sa/4.0/) - -网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](http://creativecommons.org/licenses/by-sa/4.0/) 进行许可。 - -### 特殊说明 - -#### 字体 +[![by-sa](./static/svg/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) -- [Segoe UI Emoji](https://docs.microsoft.com/zh-cn/typography/font-list/segoe-ui-emoji) © 2018 Microsoft Corporation. All Rights Reserved. +网站源代码采用 MIT 许可证；未经特殊说明，本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-sa/4.0/deed.zh) 进行许可。 -更多信息请参阅 [关于指南](/about.md#版权声明) 章节。 +更多信息请参阅 [版权说明](/postscript/copyright.md)。 diff --git a/header.html b/header.html index bd5387b57..04bcc2e3f 100644 --- a/header.html +++ b/header.html @@ -81,6 +81,16 @@

archlinux 简明指南

alt="百度统计" /> + + Contributor Covenant +