GitHubに公開されているAWSドキュメントのopen source versionを参照してみた

はじめに

清水です。AWSを利用する際には公式ドキュメントの参照が欠かせないかと思います。

• AWS Documentation
• AWS ドキュメント | AWS

本日も調べ物のためいくつかのサービスのDeveloper Guideを参照していたところ、これらのAWSドキュメントがGitHub上でopen source versionとして公開されていることがわかりました。本エントリではこのGitHub上で公開されているAWSドキュメントのopen source versionについてのリンク先や現在公開されているサービスなどをまとめてみます。

参照してみた

GitHub上の以下のOrganizationで公開されていました。

• Amazon Web Services - Documentation · GitHub
  • https://github.com/awsdocs

このページから各リポジトリを参照することもできますが、一部のAWSサービスについては下記のように、HTML版のドキュメントのヘッダー部分にGitHubへのリンクボタンが付与されています。

こちらのリンクをたどると該当するドキュメントがGitHub上で参照できます。こちらはAmazon CloudFront Developer Guideですが、Markdown形式となっていますね。

リポジトリのトップページ（README.md）にはDevleoper Guideの説明、またLicense Summaryについても記載があります。こちらはAmazon Rekognition Developer Guideです。

なおドキュメントのページによっては、HTML版のDeveloper Guideの更新が先行し、GitHub上には反映されてないものもあるようですのでご注意ください。（例えば現時点（2018/01/16）で、Amazon CloudFront Developers GuideのWorking with Web DistributionsのTopicsの項目のうち、「Using Field-Level Encryption to Help Protect Sensitive Data」についてはGitHub上のopen source versionには項目がありませんでした。）

現在GitHub上で参照できる項目をまとめてみた

GitHubのAmazon Web ServicesのOrganizationページを見た限り、現時点（2018/01/16）ではRepositoriesが81個ということで、AWSの全サービスを網羅しているわけではなさそうです。またRepository名としては「developer-guide」などの文字列が含まれていない、例えばaws-sdk-phpというリポジトリもあります。こちらはDeveloper Guideではなく"Official repository of the AWS SDK for PHP"ということでした。

そのほかどのようなRepositoryがあるか、ページを遷移して検索していくのも面倒かな、ということでGitHub APIを使ってリストにしてみました。

GitHub APIで情報を取得、以下の具合で処理をしています。

 $ curl 'https://api.github.com/orgs/awsdocs/repos?page=1&per_page=100' | jq -rc '.[] | [.name,.html_url,.description] | @csv' | sed -e "s/\"//g"| awk -F"," '{print "| <a href=\""$2"\" rel=\"noopener\" target=\"_blank\">"$1"</a> | "$3" |";}' | sort | pbcopy

エントリ執筆時（2018/01/16）の情報であることにご注意ください。また最新情報についてはご自身でのご確認をお願いいたします。

まとめ

AWSドキュメントのopen source versionをGitHubから参照してみました。これまでもAWSのドキュメントはHTML版の他、PDF版やKindle版がありましたが、open source versionとしてGitHub上で扱えるのは大変うれしいですね。社内のメンバーからも「アップデートとか追いやすそう！」とか「差分がわかるのが嬉しい！」などの声が上がっていました。確認した限りではDeveloper Guide系はMarkdown形式のものが多かったので、変更箇所の比較や、ローカルPC上で全文検索する、など多様な活用が考えられるのではないでしょうか。GitHub版のAWSドキュメントopen source versionも上手に活用してさらにAWSの知識を深めていきたいと思います。