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

2018.01.16

はじめに

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

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

参照してみた

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

このページから各リポジトリを参照することもできますが、一部の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)の情報であることにご注意ください。また最新情報についてはご自身でのご確認をお願いいたします。

Repository Name(Link) Description
AWSKinesisAnalyticsApiDoc Developer guide documentation for Amazon Kinesis Analytics
amazon-application-discovery-user-guide The open source version of the Amazon Application Discovery Service docs.
amazon-cloud-directory-developer-guide The open source version of the Amazon Cloud Directory docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-cloudfront-developer-guide The open source version of the Amazon CloudFront documentation
amazon-comprehend-developer-guide The open source version of the Amazon Comprehend docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request
amazon-dynamodb-developer-guide The open source version of the Amazon DynamoDB docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-efs-user-guide The open source version of the Amazon Elastic File System (EFS) User Guide. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-elasticache-docs The open source version of the Amazon ElastiCache User Guide. You can submit feedback and requests for changes by submitting issues in this repo or by making proposed changes and submitting a pull request.
amazon-glacier-developer-guide The open source version of the Amazon Glacier docs
amazon-guardduty-user-guide The open source version of the Amazon GuardDuty documentation. You can provide feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-inspector-user-guide The open source version of the Amazon Inspector documentation. You can provide feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-kinesis-data-firehose-developer-guide The open source version of the Amazon Kinesis Data Firehose docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-kinesis-data-streams-developer-guide The open source version of the Amazon Kinesis Data Streams docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-lex-developer-guide The open source version of the Amazon Lex docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-migrationhub-user-guide The open source version of the Amazon Migration Hub docs.
amazon-pinpoint-developer-guide The open source version of the Amazon Pinpoint Developer Guide
amazon-pinpoint-user-guide The open source version of the Amazon Pinpoint User Guide. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-polly-developer-guide The open source version of the Amazon Polly docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-quicksight-user-guide The open source version of the Amazon Quicksight docs.
amazon-rds-user-guide The open source version of the Amazon RDS docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-redshift-developer-guide This is the documentation for the Amazon Redshift Developer Guide
amazon-redshift-getting-started-guide The open source version of the Amazon Redshift Getting Started Guide.
amazon-redshift-management-guide The open source version of the Amazon Redshift Cluster Management Guide.
amazon-rekognition-developer-guide The open source version of the Amazon Rekognition docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-route53-docs Documentation for Amazon Route 53. Amazon Route 53 is a web service that provides DNS service
amazon-s3-developer-guide The open source version of the Amazon S3 docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-s3-getting-started-guide The open source version of the Amazon S3 docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-s3-user-guide The open source version of the Amazon S3 Console User Guide. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-sagemaker-developer-guide The open source version of the Amazon SageMaker docs
amazon-sumerian-user-guide The open source version of the Amazon Sumerian User Guide
amazon-transcoder-developer-guide The open source version of the Amazon Elastic Transcoder docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-transcribe-developer-guide The open source version of the Amazon Transcribe docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
amazon-translate-developer-guide The open source version of the Amazon Translate docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request
aws-android-developer-guide Content for the AWS Mobile SDK for Android Developer Guide
aws-artifact-user-guide The open source version of the AWS Artifact docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-certificate-user-guide The open source version of the AWS Certificate Manager user guide.
aws-cli Universal Command Line Interface for Amazon Web Services
aws-cli-user-guide The open source version of the AWS CLI User Guide
aws-cloud9-user-guide The open source version of the AWS Cloud9 User Guide. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-cloudformation-user-guide The open source version of the AWS CloudFormation User Guide
aws-cloudhsm-user-guide Official repository of the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/)
aws-codedeploy-user-guide The open source version of the AWS CodeDeploy User Guide. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-codepipeline-user-guide The open source version of the AWS CodePipeline User Guide. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-cost-management-user-guide The open source version of the AWS Billing and Cost Management docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-cpp-developer-guide Content for the AWS SDK for C++ Developer Guide. For more info about the AWS C++ SDK
aws-deep-learning-amis This is the documentation for AWS Deep Learning AMIs: your one-stop shop for deep learning in the cloud
aws-directory-service-admin-guide The open source version of the AWS Directory Service docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-dms-step-by-step The open source version of the AWS DMS docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-dms-user-guide The open source version of the AWS DMS docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-doc-sdk-examples Code examples used in the official AWS SDK documentation.
aws-doc-shared-content Shared content for public AWS documentation
aws-elastic-beanstalk-developer-guide The open source version of the AWS Elastic Beanstalk Developer Guide. You can submit feedback and requests for changes by submitting issues in this repo or by making proposed changes and submitting a pull request.
aws-encryption-sdk-docs Explains how to use the AWS Encryption SDK
aws-example-apps
aws-glue-developer-guide The open source version of the AWS Glue docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-go-developer-guide AWS SDK for Go Developer Guide
aws-greengrass-developer-guide The open source version of the AWS Greengrass developer guide
aws-ios-developer-guide Content for the AWS Mobile SDK for iOS Developer Guide
aws-java-developer-guide Official repository of the AWS SDK for Java Developer Guide -- issues and contributions are welcome
aws-java-developer-guide-v2 Official repository of the AWS SDK for Java v2 Developer Guide
aws-kms-developer-guide Official repository of the AWS KMS Developer Guide (https://docs.aws.amazon.com/kms/latest/developerguide/)
aws-lambda-developer-guide Lambda User Guide and API operations and how it integrates with other AWS Service
aws-mobile-developer-guide The public documentation on docs.aws.amazon.com for AWS Mobile Hub and SDKs.
aws-net-developer-guide Amazon Web Services SDK for .NET
aws-organizations-docs The open source version of the AWS Organizations documentation. We welcome and encourage your feedback. You can submit feedback and requests for changes by submitting issues in this repo or by making proposed changes and submitting a pull request.
aws-powershell-user-guide Official documentation source for the AWS Tools for Windows Powershell User Guide
aws-ruby-developer-guide Source for the AWS SDK for Ruby Developer Guide. Provides information about how to install
aws-sct-user-guide The open source version of the AWS Schema Conversion Tool docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-sdk-php Official repository of the AWS SDK for PHP (@awsforphp)
aws-serverlessrepo-developer-guide The open source version of Developer Guide for AWS Serverless Application Repository. You can submit feedback and requests for changes by submitting issues in this repo or by making proposed changes and submitting a pull request.
aws-single-sign-on-user-guide The open source version of the AWS Single Sign-On docs. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
aws-toolkit-eclipse-user-guide Content for the AWS Toolkit for Eclipse User Guide
aws-toolkit-visual-studio-user-guide Toolkit for Visual Studio is a plugin for the Visual Studio IDE.
aws-unity-developer-guide Content for the AWS Mobile SDK for Unity Developer Guide
aws-waf-and-shield-advanced-developer-guide How to get started with AWS WAF and AWS Shield Advanced
aws-xamarin-developer-guide Content for the AWS Mobile SDK for Xamarin Developer Guide
aws-xray-developer-guide The open source version of the AWS CLI User Guide
boto3 AWS SDK for Python
botocore The low-level
iam-user-guide Official documentation source for the AWS Identity and Access Management (IAM) User Guide
macie-user-guide The open source version of the Amazon Macie documentation. You can provide feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.

まとめ

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