Skip to content
ykla edited this page Nov 24, 2023 · 16 revisions

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

基本原则

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

  2. 有问题请在 issue 指出。

  3. Github 编辑者不应改变目录结构,会导致 Gitbook 同步失效。如有需要请联系 ykla。

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

  5. 请加 QQ 群 787969044 或 Telegram 群

详细说明

首先,明确原则:我们的目标并非是 Handbook 的翻译,而是编写一本类似于《鸟哥的 Linux 私房菜:基础学习篇》+《鸟哥的 Linux 私房菜:服务器架设篇》二合一的基于 FreeBSD 的教程。也就说我们是 Handbook 的超集。

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

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

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

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

本项目采用 BSD-3-Clause 授权许可,请注意版权问题。

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

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

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

为了方便沟通,长期编写者应该加入 https://github.com/FreeBSD-Ask 团队以及 QQ 或 TG 群组(见基本原则第 5 条)。

对于编写时长问题,理论上会一直持续下去,跟随每个 FreeBSD 大版本迭代。本项目开始于 2021 年 11 月。

对于非中文用户,参见 https://github.com/FreeBSD-MFGA

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

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

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

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

Clone this wiki locally