Skip to content
ykla edited this page Jun 20, 2025 · 20 revisions

欢迎来到《FreeBSD 从入门到跑路》的编辑指南!

贡献指南

如果你想让你的教程出现在本书中,你可以这样做:

  • 如果你熟悉 GitHub,可以点击电脑端右侧的“编辑此页”,进入项目进行操作。整个项目使用 Markdown 语法 + Gitbook,简单易上手(具体详见项目 WiKi);
  • 如果以上有困难,你还可以发 PDF、Word 或者 TXT 给我。请将文件发送至 [email protected];如果有视频教程,以各大云盘链接为宜。

本书现接受以下内容:

  • 一切与 BSD 相关(包括不限于 FreeBSD,OpenBSD,NetBSD)以及各种体系结构的教程。你既可以扩充当前教程,也可以新建一节;
  • 下方的 ToDo 列表;
  • 你亦可在文学故事章节分享你与 BSD 的故事,你的个人心得体会。

你为什么要这样做?

  • 可访问性:随处可见,无需再到处寻找;
  • 可复现性:任何人都能轻松复现成果,显著提高工作和学习效率;
  • 规模化测试:可以对教程进行系统化测试,找出最优解;
  • 社区支持:社区将持续维护教程的可用性,并定期更新软件和教程版本;
  • 节省时间:当本教程内容愈加丰富,你花在网络索引上的无效时间就会越少;
  • 互惠互利:合并教程践行了开源哲学,惠及着无穷的远方,无数的人们;
  • 增强协作:促进 FreeBSD 在中国乃至亚洲、全世界的发展;
  • 便于反馈:快速迭代教程,并验证每一步骤的正确性与合理性;
  • 易于分享:本项目既支持在线浏览亦支持 PDF 文档导出,宽松的许可证、简单的项目结构允许自由部署。

唯一要注意的是,你的教程会以本项目的开源许可证(BSD)进行发布。

基本原则

  1. 尽可能详细和基础,不要假定用户有任何使用背景。

  2. 有问题请在 issue 指出。

  3. 使用大型软件(如IDE、JAVA)时,请注明软件版本号。

  4. 出于可靠性考虑,原则上禁止引用阮一峰(https://www.ruanyifeng.com/)相关内容

详细说明

首先,明确原则:我们的目标并非是 Handbook 的翻译,我们是 Handbook 的超集。

撰写原因:为了更好的推广 FreeBSD,使之中国化与世界化。我们坚信 FreeBSD 的一时衰微并不能代表什么,FreeBSD 现状主要是其缺乏上层应用软件的构建,比如 Linux 有 docker,而 FreeBSD 有 jail,但是 Jail 并没有大规模应用,就是如此。

其次,受限于 Gitbook 原因,可能在编辑我编辑过的页面时,会遇到很多 “\” 符号,全部删去即可。

不应该使用 sudo 而应该用 “#” 代替,除非特例;一般用户权限请使用 “$ ”表示。

安装软件时,尽量给出 pkg 或 ports 两种方法。

请注意版权问题。

编辑时尽量以 FreeBSD release 14.3 为基准,避免出现 pkg_add 此类过时东西。如实必要,必须予以注明版本。

对基本原则第 1 条的详细解释:对用户的要求,以用户有通过 全国计算机等级考试(NCRE) 二级任意科目的能力为编写难度基准。这里借用 Ubuntu 论坛的一句话的改编与大家共勉:“我们都知道新人的确很菜,也喜欢抱怨,并且带有浓厚的 Linux 习惯,但既然在这里询问,我们就应该有责任帮助他们解决问题,而不是直接泼冷水、简单的否定或发表对解决问题没有任何帮助的帖子。乐于分享,以人为本,这正是 FreeBSD 的精神所在。”

客观看待其他操作系统与 FreeBSD 的关系,不应该存在莫名的敌视行为。另外 FreeBSD 并非 UNIX 系统,这一点要特别注意。

对于编写时长问题,理论上会一直持续下去,跟随每个 FreeBSD 大版本迭代。

由于种种原因,无法立即验证所写内容是否正确无误时,请编辑者打上“警告:以下内容为理论,未经实际测试,仅供参考,如果可以使用请提交 issue 以移除本标签。”标签以作区分。

不应该对文学故事章节进行除错字排版以外的删减。

请勿使用诸如 gitee 等境内无法确保信息安全与数据稳定的平台。

重要: 新建章节建议发 issue 让 ykla 来操作,自己操作时,请注意写入目录到 https://github.com/FreeBSD-Ask/FreeBSD-Ask/blob/main/SUMMARY.md 否则不会生效。

Clone this wiki locally