Jolla Unofficial Chinese Blog

介绍Sailfish系统wiki


Sailfish系统wiki已经公测,在这里找到你关于Sailfish平台开发和软件开发的一切 !

这篇博客将为大家介绍Sailfish系统Wiki 1。前几个月我们的水手们就开始忙着撰写添加文档到 wiki。虽然还有许多工作要做,但已经足够以“公测”发布。这篇文章将介绍为何wiki的重要性, wiki提供的信息,我们对社区贡献wiki的考量,以及列出社区最感兴趣的一些章节。

关于Wiki

Sailfish系统Wiki 旨在提供一份全方位的、进化的、有生命力的文档。它将详细介绍Sailfish系统平台构成组件,描述各组件的交互方式。作为一个开放平台,一份详实的文档对Sailfish系统的成长十分重要。它对降低贡献门槛起到举足轻重的作用。更进一步讲,随着平台的进化,文档随之更新十分重要——这一性质来讲,wiki的形式非常适合Sailfish 系统文档。Sailfish系统wiki的最终目标,是社区成员在向Sailfish系统平台贡献代码时,能够同时在wiki更新代码修改相关软件组件文档。

文档的全面性非常重要,同时也不能忽视文档内容的易得性。也就是说,这些信息必须按逻辑分类,修改成适合读者的格式,在形式和样式上可编辑,还要确保受版权保护的内容不会再无许可情况下被加进来。在这一点上看,Sailfish系统wiki如同一个软件仓库,跟Mer项目GitLab或者GitHub很像: wiki会有维护者,每个更改都由多个贡献者审阅投票。这些贡献的审阅形式以怎样的方式进行,项目成员权限许可如何分配(包括合作贡献者和社区贡献者),这些我们还没定下来,我们也会在近期在社区进行讨论。

构架文档和合作贡献文档

最近,Jolla的水手正在往wiki添加各种章节,包括了应用开发(在Sailfish系统平台上开发)和系统开发(对Sailfish系统平台本身的开发)。在这篇博客里,我们想特别指出两个地方:架构文档和合作贡献文档。如果你有心贡献,这些wiki章节能提供给你提交贡献到Sailfish系统平台的必要信息,比如如何提交BUG反馈,完成一个单元测试,完善文档,修正问题或者实现一个软件组件新特性。

Sailfish系统wiki构架文档 包含了Sailfish 系统平台构架总瞰。其中涵盖了多层软件组件,这些组件相互依赖并提供最终用户体验。从底层组件像 硬件抽象层 ,提供系统服务的多个中间件组件交互接口 ,到提供用户体验构建于UI子系统 之上的高级应用接口。在读完这些章节后,你应该丢Sailfish系统各组件如何相互适配有所了解,并明白你有兴趣贡献的组件。

Sailfish系统合作贡献文档 描述了如何贡献到Sailfish系统本身。这份文档涵盖了这方面相关信息,包括如何填写BUG汇报,如何克隆源代码仓库,如何编辑代码并提交代码修改申请,修改的代码如何被检阅、接受并合并到最终版本,以及质量检测如何进行。其中还包含了一个Sailfish系统浏览器补丁文档示例,告诉你如何 一步一步 提交补丁。最后,文档还包含了一份Sailfish系统组件列表,并附带一些有经验的开发者信息,如果你想对此贡献代码,你可以联系他们!

下一步

我们下一步打算允许社区成员自行创建账户,添加内容和做出修改。如上面提到的,我们希望在修改合并到wiki之前,能像代码检阅一样检阅这些修改;因此,我们目前还没准备好向所有人开放。我们需要设计一些方案,包括整个进程如何设计,以及以怎样的形式进行。然后,在实践之前,我们会将这些方案与社区讨论,选出最好的一个。在不久后,我们会在IRC频道组织一次Sailfish系统社区会议,详尽地讨论这些细节。

在那之前,如何你有任何wiki建议,或需要反馈wiki任何问题,比如网页太慢或者连接失效,请通过电子邮件或IRC联系David Greaves或者Jarkko Lehtoranta。

我们期盼着在不久的将来与你更近地合作,一起构建一个开放的未来!

感谢, Sailfish系统Wiki团队


  1. Wiki,一种网络上允许多人创建和连接内容的体系。Wiki不同于百科,而中文音译“维基”则常代“维基百科”,故此保留英文。 


Sailfish OS Wiki Team

由Jolla 酷炫工程师组成的团队


Translated by

TylerTemp

TylerTemp是一只Python程序员。你可以在这些地方找到我哦:      

如果你喜欢我的作品,你可以买我一杯啤酒,让我做的更好:  |  Flattr this