Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: refactor cicd sample and update to CDK Pipelines #50

Merged
merged 22 commits into from
Jun 1, 2022
Merged

feat: refactor cicd sample and update to CDK Pipelines #50

merged 22 commits into from
Jun 1, 2022

Conversation

wmikuriy
Copy link
Contributor

The CICD sample code was refactored to the implementation by CDK Pipelines, and the code structure was updated to conform to the current CDK practices.


By submitting this pull request, I confirm that my contribution is made under the terms of the MIT No Attribution (MIT-0).

Copy link
Contributor

@konokenj konokenj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

コード内のレビューコメントをご参照ください。英語のMarkdownには注釈を入れていません。日本語へのフィードバックにあわせて英語も修正してください。

doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved

ユースケースサンプルとして提供されている CDK アプリケーションは GitHub に置かれた Baseline Environment on AWS (BLEA) CDK Pipelines によるパイプラインをデプロイします。

# デプロイの概要
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

図で示したいものを明確にする

ここで示したいのは、①パイプラインそのものの構築プロセス でしょうか?それとも、②パイプラインがどのように動いてアプリケーションのデプロイが進行するか でしょうか?それとも、③アカウント構成のパターンでしょうか?

私には①と③が混在しているように読み取れました。しかしそれも、非常に注意深く図を注視しないとわかりません。以下が課題だと思います。

  1. Deploy BLEA 1/5 という図中のタイトルを見ると、どうもBLEAそのものをデプロイするステップの1つめというように見えます。しかし、実際にはこれは1つのユースケースのなかの、デプロイ方法の選択肢の1つです。
  2. 2/54/5, 5/5 はアカウント構成パターンの違いに見えます。1/5を見たときにステップだと認識しましたが、違うようです。
  3. 3/5 はデバッグ用にパイプラインを使わずにデプロイする非常ハッチのように見えます。これが順序立ててこの中にあること、さらにこれがオプションであることが明記されていないため、とても混乱します。

図を改善する

  • フォントが小さすぎて読みづらいです
  • オブジェクトの位置がそれぞれ違っていて、差分を読み取れません。統一することは難しいでしょうか?

文章による注釈を加える

  • 図が何をしようとしているか、文章で説明してください

まとめ

意図が異なる図は、まとまりが認識できるように分離して置いてください。また、タイトルを適切につけ、連番を正しく使ってください。

@@ -0,0 +1,273 @@
# Baseline Envirionment on AWS デプロイパイプライン (GitHub 版)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CDK Pipelines についての簡単な説明や、AWSドキュメントへのリンクを入れることを検討してください。ユーザーがこのページを見たときに、これが何をするものなのか、どのような前提知識が必要なのかを最初の数行で理解してもらえるように説明しましょう。

usecases/guest-webapp-sample/cdk.json Outdated Show resolved Hide resolved
usecases/guest-webapp-sample/package.json Show resolved Hide resolved
@wmikuriy wmikuriy requested a review from konokenj May 26, 2022 08:52
Copy link
Contributor

@konokenj konokenj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

コメントをご確認ください。多くの差分にsuggestionを入れているので、内容を確認して問題なければ受け入れてください。

doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment_ja.md Outdated Show resolved Hide resolved
doc/PipelineDeployment.md Outdated Show resolved Hide resolved
doc/PipelineDeployment.md Outdated Show resolved Hide resolved
@ohmurayu ohmurayu merged commit fa0949a into aws-samples:main Jun 1, 2022
@wmikuriy wmikuriy deleted the feature/cdk_pipeline_refactor_pr branch June 1, 2022 08:12
terayas pushed a commit to terayas/baseline-environment-on-aws that referenced this pull request Jun 13, 2022
* feat: refactor cicd sample and update to CDK Pipelines (remove old sample pipeline in tools/cicd)

Co-authored-by: Wataru Mikuriya <wmikuriy@amazon.com>
Co-authored-by: Kenji Kono <93309555+konokenj@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants