贡献文档

Sails 网站上的官方文档来自 sails 代码库中的 markdown 文件。请向 master 分支提交拉取请求，其中包含您的修改，我们会尽快进行审核和合并。

我们乐于接受有关文档管理流程的建议，以及与社区的合作。请在 Gitter 上发布您的想法；如果您有兴趣直接帮助我们，请在 Twitter 上联系 @fancydoilies 或 @mikermcneil。

我应该编辑哪个分支？

这取决于您要进行的修改类型。大多数情况下，您进行的修改将与 Sails 的最新稳定版本相关（即 NPM 上的版本），因此您需要编辑 此 代码库的 master 分支（默认情况下，您在 sails 代码库中看到的内容）。文档团队会将 master 合并到 Sails 最新稳定版本的相应分支，然后大约每周一次将其部署到 sailsjs.com。

另一方面，如果您进行的修改与即将发布的版本中的未发布功能有关（通常作为对 Sails 或相关项目的特性建议或开放式拉取请求的补充），那么您需要编辑下一个未发布版本的 Sails 的分支（有时称为 "edge"）。

分支（在 sails 或 sails-docs 中）	Sails 版本的文档...	预览地址...
master		preview.sailsjs.com
0.12	Sails v0.12.x	sailsjs.com
0.11	Sails v0.11.x	0.11.sailsjs.com

这些文档如何编译并推送到网站？

我们使用名为 doc-templater 的模块将 .md 文件转换为网站的 HTML。您可以在 doc-templater 代码库 中了解更多有关其工作原理的信息。

每个 .md 文件在网站上都有其自己的页面（例如，所有参考、概念和解剖文件），并且应该包含一个特殊的 <docmeta name="displayName"> 标签，其中包含一个 value 属性，用于指定页面的标题。这将影响文档页面在搜索引擎结果中的显示方式，并且还将用作其在 sailsjs.com 上的导航菜单中的显示名称。例如

<docmeta name="displayName" value="Building Custom Homemade Puddings">

我的更改何时会在 Sails 网站上显示？

文档更改会在合并到与当前 Sails 稳定版本相对应的特殊分支（例如 0.12）时生效。我们无法合并直接发送到此分支的拉取请求 - 它的唯一目的是反映当前托管在 sailsjs.com 上的内容，并且内容仅在重新部署 Sails 网站之前才会合并。

如果您想查看文档更改如何在 sailsjs.com 上显示，可以访问 preview.sailsjs.com。预览网站会在将更改合并到 sails 的 master 分支时自动更新。

我如何帮助翻译文档？

帮助 Sails 项目的一个好方法是自愿翻译 Sails 文档，尤其是如果您是英语以外的语言的母语使用者。

如果您有兴趣开始翻译项目，请按照以下步骤操作

• 将 sails 代码库（balderdashy/sails/docs）中的文档文件夹放到一个名为 sails-docs-{{IETF}} 的新代码库中，其中 {{IETF}} 是您语言的 IETF 语言标签。
• 编辑 文档的 README，以总结您的进度，提供您认为对阅读您的翻译的其他读者有用的任何其他信息，并让感兴趣的贡献者知道如何与您联系。
• 当您对翻译的第一个完整版本感到满意时，请打开一个问题，我们文档团队的某位成员将很乐意帮助您在 Sails 网站的上下文中预览它，将其发布到一个域名（您的域名或 sailsjs.com 的子域名，以最适合您的情况为准），并与 Sails 社区的其他成员分享。