开源共创一起写
2024年11月30日 13:00-22:00
2024年12月1日-12月3日
这两本书的写作计划其实在很多年前就开始了。
之前组织过几次,也有一些人参与进来,但都没什么进展。现在,我们换了新版的网站,有了新的系统支持和进展,这项工作终于可以正式开始了。
写作计划
目前我们在写作的有两本书:
《FreeSWITCH 案例大全》,很简单,大家在使用 FreeSWITCH 的过程中肯定积累了很多经验,把这些经验收集起来,就是一笔很大的财富。你可以把这些财富自己珍藏着,也可以分享给大家,就如同当初你学习 FreeSWITCH 的时候大家无偿地分享给了你一样。
《FreeSWITCH 参考手册》,目标也很明确。大家经常会问到我,有没有关于 FreeSWITCH 里所有事件的列表?有没有事件里所有字段的说明?有没有挂机原因的中文解释?有没有通道变量的解释?有没有数据库的说明?这些,虽然官方有 Wiki 上有一些,但毕竟是英文的,而且也不全。
线上版的书里已经有些内容了,大家可以先看看,应该知道我大致想写成什么样子。
最近,FreeSWITCH 官方也改版了 Wiki,新的链接变成了https://developer.signalwire.com/freeswitch/。官方的文档也是社区创作的成果。之前,我们希望能做一个中文的 Wiki,但做一个中文的 Wiki 太难了,这次,我想写本书。如果不过瘾,就写两本。
写一本书是不是很难?是的,但也不全是。想一想:
- 如果每天写一个 API 的话,能不能完成?一年下来,就是 300 多个。
- 如果每天写一个 App 的话,能不能完成?一年下来,又是 300 多。
- 如果每天写一个通道变量,一年下来也是 300 多。
- 随手记录一下你收到的 FreeSWITCH 中的事件,以后在工作中可以翻出来参考,记录花的时间以后再打的时候都省出来了。
- 你还可以找到很多让自己变得优秀的理由。
如果你对本书感兴趣,你可以加入我们:
- 请确认你有时间参与进来并准备好做贡献。好多人满情激情地参与进来,一篇都没写,甚至连错别字都都改过一个,又走了。
- 想想你最后一次坚持做一件事情是什么时候?
- 你会得到本书的源代码。
- 跟运动健身一样,你会找到一些志同道合的朋友,互相鼓励、互相监督。
- 你会与我们一起工作,一起创作,一起 Review,一起合代码。
- 你会自己学会如何将本书编译成 PDF。
- 你可以加入我们的作者和读者群。
- 好处可能还有很多。
- 加入我们也不需要技术有多牛,如果你会 Git、会 Markdown,可以帮我们一起找错别字,督促大家按时完成任务,我们也欢迎后勤部长和啦啦队长。
- 加入我们很简单,到我们的Git 站点上创建个账号,你就加入我们了。
- 你可以到这里联系我们,也可以给我们发邮件
info@x-y-t.cn
,注意发邮件时说明白你要做什么并留下你的联系方式。如果你跟我们不是特别熟悉,请发 300 字以内的自我介绍,让我们了解一下你。 - 另外,最重要的是:你需要提交一份写作计划。格式不限。
本书仅对贡献者开源。本书的内容是可以在线免费阅读的。
期待你的加入。
FAQ
我可以加入吗?
欢迎。我们没有门槛,只要你是认真的。
怎么才算认真?
如果加入我们一个月内,连个错别字都没改过,那几乎可以认为是不认真。如果你提交了一些内容,然后半年或一年没有动作,那就是不爱我们了。
如果你还不理解什么是我们期望的认真,那就从头再看一遍本文章。
为什么不在 Github 上共享了?
我们喜欢 Github,但是,我们放了几年之后,没有收到一个 PR,只收到一个 Issue,和寥寥几个 Star。很多国内的同学反而上 Github 有困难,我们需要把仓库放到我们自己的 Git 站点上。如果同时维护两个地方会非常复杂,因此,我们暂时关闭了 Github 上的仓库。
为什么源代码仓库不直接开放给所有人?
我们的源代码是使用 Markdown 组织的,我们使用 Pandoc 生成了 HTML,这样更易读一些。大部分人不需要读源代码,如果需要的话,可以加入我们,一起创作。
为什么不在 Gitbook 上发布?
我们希望把代码放到自己的仓库里,我们要用自己的方法生成 PDF。
这些书将来会出版吗?
也许会,也许不会,要看书的质量和反响。但我想大概率不会,因为可能一直在更新完,更适合电子版免费渐进发行的方式。但如果有人赞助,也说不定。