ドキュメントへの貢献

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ファイルはウェブサイト上の独自のページを持ち（例：すべてのreference、concepts、anatomyファイル）、ページのタイトルを指定するvalueプロパティを持つ特別な<docmeta name="displayName">タグを含める必要があります。これにより、検索エンジンの結果にドキュメントページがどのように表示されるかが影響を受け、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を編集して、これまでの進捗状況を要約し、翻訳を読む他の人にとって役立つと思われるその他の情報を提供し、興味のあるコントリビューターがあなたに連絡する方法を知らせてください。
• 最初の完全な翻訳バージョンに満足したら、issueを開いてください。ドキュメントチームの誰かが、Sailsウェブサイトのコンテキストでプレビューするのを手伝い、ドメイン（あなた自身のドメイン、またはsailsjs.comのサブドメインのいずれか、最も理にかなっている方）で公開し、Sailsコミュニティの他のメンバーと共有するのを手伝います。