貢獻文件

Sails 網站上的官方文件是從 sails 儲存庫中的 markdown 檔案編譯而來。請將修改意見以 pull request 的形式發送到 master 分支，我們會盡快進行雙重檢查並合併。

我們樂於接受關於文件管理流程以及與社群合作的建議。請將您的想法發佈到 Gitter；或者，如果您有興趣直接提供協助，請在 Twitter 上聯繫 @fancydoilies 或 @mikermcneil。

我應該編輯哪個分支？

這取決於您要進行的編輯類型。大多數時候，您會進行與最新穩定版 Sails（即 NPM 上的版本）相關的編輯，因此您會希望編輯此儲存庫的 master 分支（您在 sails 儲存庫中預設看到的）。文件團隊每週會將 master 分支合併到適用於最新穩定版 Sails 的分支，然後將其部署到 sailsjs.com 約一次。

另一方面，如果您要進行與即將發布的版本中未發布的功能相關的編輯 — 通常是為了配合功能提案或對 Sails 或相關專案的開放 pull request — 那麼您會希望編輯下一個未發布版本的 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）對應的特殊分支時生效。我們無法合併直接發送到此分支的 pull request — 其唯一目的是反映目前託管在 sailsjs.com 上的內容，並且內容僅在重新部署 Sails 網站之前合併。

如果您想查看文件變更在 sailsjs.com 上的顯示效果，您可以訪問 preview.sailsjs.com。預覽網站會在變更合併到 sails 的 master 分支時自動更新。

我如何協助翻譯文件？

協助 Sails 專案的一個好方法，特別是如果您是以英語以外的語言為母語的人，是自願翻譯 Sails 文件。

如果您有興趣開始翻譯專案，請按照以下步驟操作

• 將 sails 儲存庫 (balderdashy/sails/docs) 中的文件夾複製到一個名為 sails-docs-{{IETF}} 的新儲存庫中，其中 {{IETF}} 是您的語言的 IETF 語言標籤。
• 編輯 文件 README 以總結您目前的進度，提供您認為對其他閱讀您的翻譯的人有幫助的任何其他資訊，並讓有興趣的貢獻者知道如何與您聯繫。
• 當您對第一個完整的翻譯版本感到滿意時，請開啟一個 issue，我們文件團隊的成員將很樂意協助您在 Sails 網站的上下文中預覽它，使其在網域（您的網域或 sailsjs.com 的子網域，以最合理的為準）上線，並與 Sails 社群的其他成員分享。