AWS ドキュメントがオープンソースになり、GitHub でご利用可能に

今年に入ってから GitHub のリポジトリとして、AWS SDK の開発者ガイドを公開 (すべて awsdocs 組織で閲覧可能) し、関心を示した団体・組織を招いて、プルリクエスト (編集結果の送信) 方式で変更および改善への協力を募りました。

今日現在で、さらに 138 件の開発者ガイドとユーザーガイドが組織に追加されています。さらに皆さんからのリクエストが届くのを楽しみにしています。皆さんには正確さや分かりやすさの観点から、バグの修正、コードサンプルの改善 (または新しいサンプルの送信)、詳細の追加、 文や段落の書き換えなどにご参加いただけます。また新しい機能やサービスの開始についてさらに詳しく学んだり、ドキュメントの改善を追跡するために、コミット履歴を見ることもできます。

参加する
始める前に、関心のある AWS サービスについて Amazon Open Source Code of Conduct を一読し、Contributing Guidelines の文書をご覧ください (一般的に CONTRIBUTING.mdという名称)。その後、GitHub のアカウントをまだお持ちでなければ、アカウントを作成します。

変更または改善する内容を見つけたら、文書の HTML 版にアクセスし、ページの上部で Edit on GitHub (GitHub で編集) ボタンをクリックします。

この操作により、ソース形式 (一般的な Markdown または reStructuredText 方式) で文書を編集できるようになります。 ソースコードは文書を HTML、PDF、および Kindle 版で生成するために使用されます。

GitHub にアクセスしたら、鉛筆アイコンをクリックしてください。

これにより「フォーク」が作成されます。フォークとは独立した環境でファイルを編集できるようにファイルを別途コピーしたものです。

次に編集を行います。一般的に、オープンソースプロジェクトの新しい参加者として、あなたは小規模な、質の高い編集を行うことで経験を積み、評判を高める必要があります。たとえば、文書で「dozens of services」を「over one hundred services」に変更するとします。

次に、変更内容を要約し、Propose file change (ファイルの変更を提案) をクリックします。

変更内容を検証するために、差分を確認し、Create pull request (プルリクエストを作成) をクリックします。

その後、詳細を見直し、Create pull request (プルリクエストを作成) を再びクリックします。

プルリクエスト (別名 PR) は Elastic Beanstalk 文書チームに送られ、その変更内容を反映させるか、却下するか、あるいは、さらに詳しい情報を得るために送信者に情報の提供を求めるかどうかが決定されます。チームはできるだけ PR に 48 時間以内に回答し、PR のステータスが変化すると GitHub から送信者に通知が届きます。

ほとんどのオープンソースプロジェクトと同様、絞り込んだそれほど大きくない規模のプルリクエストをこまめに送信する方が、時々大量の編集をひとまとめにして送るのよりも好まれます。

長期間にわたりリポジトリへの変更を追跡したいときは、Watch および/または Star 機能を使って追跡できます。

リポジトリを Watch すると、そのサービスガイドに新らしいリリース、公開、またはプルリクエストなどがあったときにメールが届きます。

Fork (フォーク) する
今回の開始により、AWS の改善に役立つ手段が利用できるようになりました。 皆様のご感想をお待ちしております。

— Jeff;