Skip to content

Commit bbb58d6

Browse files
committed
Merge docs updates.
2 parents 5b41a15 + b32743b commit bbb58d6

13 files changed

+71
-15
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ The contents of this setting are as follows.
209209

210210
> NOTE: See the following explanation for how to use Context
211211
>
212-
> - [Manage personal environment by cdk.context.json](doc/HowTo.md#cdkcontextjson-Manage-personal-environment)
212+
> - [Manage personal environment by cdk.context.json](doc/HowTo.md#Manage-personal-environment-by-cdkcontextjson)
213213
>
214214
> - [Accessing context in application](doc/HowTo.md#accessing-context-in-application)
215215
@@ -352,7 +352,7 @@ This completes the baseline and sample application deployment for a single accou
352352
From now on, you will use this sample code as a starting point to develop applications tailored to your use case. Indicates information necessary for general development.
353353
354354
- [Development process](doc/HowTo.md#development-process)
355-
- [Update package dependencies](doc/HowTo.md#update-dependencies)
355+
- [Update package dependencies](doc/HowTo.md#update-package-dependencies)
356356
357357
#### 5-4. Remediation of security issues
358358

doc/DeployToControlTower.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ The contents of this setting are as follows.
263263

264264
> NOTE: See the following explanation for how to use Context
265265
>
266-
> - [Manage personal environment by cdk.context.json](doc/HowTo.md#cdkcontextjson-Manage-personal-environment)
266+
> - [Manage personal environment by cdk.context.json](doc/HowTo.md#Manage-personal-environment-by-cdkcontextjson)
267267
>
268268
> - [Accessing context in application](doc/HowTo.md#accessing-context-in-application)
269269
@@ -493,7 +493,7 @@ This completes the baseline and sample application deployment for a single accou
493493
From now on, you will use this sample code as a starting point to develop applications tailored to your use case. Indicates information necessary for general development.
494494
495495
- [Development process](doc/HowTo.md#development-process)
496-
- [Update package dependencies](doc/HowTo.md#update-dependencies)
496+
- [Update package dependencies](doc/HowTo.md#update-package-dependencies)
497497
498498
#### 7-4. Remediation of security issues
499499

doc/HowTo.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Here we will describe howTo for various settings.
77
- [VisualStudioCode Setup Instructions](#VisualStudioCode-Setup-Instructions)
88
- [Git pre-commit hook setup](#Git-pre-commit-hook-setup)
99
- [Skip Deployment Approvals and Don't Roll Back](#skip-deployment-approvals-and-dont-roll-back)
10-
- [Manage personal environment by cdk.context.json](#cdkcontextjson-Manage-personal-environment)
10+
- [Manage personal environment by cdk.context.json](#Manage-personal-environment-by-cdkcontextjson)
1111
- [Set up Slack for AWS ChatBot](#set-up-slack-for-aws-chatbot)
1212
- [Deployment with CloudShell](#deployment-with-cloudshell)
13-
- [Update package dependencies](#update-dependencies)
13+
- [Update package dependencies](#update-package-dependencies)
1414
- [Accessing context in application](#accessing-context-in-application)
1515
- [Development process](#development-process)
1616
- [Remediate Security Issues](#remediate-security-issues)
@@ -39,7 +39,7 @@ For macOS, select [Running Visual Studio Code on macOS](https://code.visualstudi
3939

4040
If you clone this repository in a subsequent step and open it in VSCode, you will be prompted to install the recommended extension. Now click on _Install_.
4141

42-
! [vscode-recommended-extensions](doc/images/VSCode-Recommended-Extensions.jpg)
42+
![vscode-recommended-extensions](../doc/images/VSCode-Recommended-Extensions.jpg)
4343

4444
This recommended extension is defined in `.vscode/extensions.json`. For more information about this feature, see [Managing Extensions in Visual Studio Code](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions).
4545

@@ -340,6 +340,14 @@ If your CDK code requires additional packages, install them as follows: Here we
340340
> ```
341341

342342
> NOTE:
343+
> When you update a CDK source code, your snap shot test (npm run test) will be failed because a generated template is differ from previous one.
344+
> If your CDK code is correct, you need to update a snapshot using command below.
345+
>
346+
> ```sh
347+
> # Update snapshot
348+
> npm run test -- -u
349+
> ```
350+
>
343351
> To build all use cases, run the following using workspaces:
344352
>
345353
> ```sh
@@ -349,6 +357,7 @@ If your CDK code requires additional packages, install them as follows: Here we
349357
> npm run format
350358
> npm run clean --workspaces
351359
> npm run build --workspaces
360+
> npm run test --workspaces -- -u # update snaphosts
352361
> npm run test --workspaces
353362
> ```
354363
>

doc/HowTo_ja.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ macOS の場合、 [Running Visual Studio Code on macOS](https://code.visualstud
3939

4040
後続の手順でこのリポジトリを clone して VSCode で開くと、推奨 Extension のインストールを促されます。ここで _Install_ をクリックます。
4141

42-
![VSCode-Recommended-Extensions](doc/images/VSCode-Recommended-Extensions.jpg)
42+
![VSCode-Recommended-Extensions](../doc/images/VSCode-Recommended-Extensions.jpg)
4343

4444
この推奨 Extension は `.vscode/extensions.json` で定義されています。この機能の詳細は [Managing Extensions in Visual Studio Code](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) をご参照ください。
4545

@@ -335,12 +335,20 @@ CDK コードで追加のパッケージが必要になった場合は、以下
335335
> npm run format
336336
> # build
337337
> npm run build
338-
> # snapshot test
338+
> # snapshot test (see NOTE)
339339
> npm run test
340340
> ```
341341

342342
> NOTE:
343343
>
344+
> CDK コードを変更した場合、以前とは異なるテンプレートが生成されるため、スナップショットテスト (npm run test) が失敗します
345+
> テンプレートが正しく生成されているならば、次のようにスナップショットの更新が必要です。
346+
>
347+
> ```sh
348+
> # Update snapshot
349+
> npm run test -- -u
350+
> ```
351+
>
344352
> 全てのユースケースをビルドするには workspaces を使用して次のように実行します。
345353
>
346354
> ```sh
@@ -350,6 +358,7 @@ CDK コードで追加のパッケージが必要になった場合は、以下
350358
> npm run format
351359
> npm run clean --workspaces
352360
> npm run build --workspaces
361+
> npm run test --workspaces -- -u # update snaphosts
353362
> npm run test --workspaces
354363
> ```
355364
>

doc/images/BLEA-GuestSampleASG.png

-31.4 KB
Binary file not shown.

doc/images/BLEA-GuestSampleEC2.png

-29.3 KB
Binary file not shown.

doc/images/BLEA-GuestSampleECS.png

-46.3 KB
Binary file not shown.
150 KB
Loading
148 KB
Loading
190 KB
Loading

0 commit comments

Comments
 (0)