From 85d60fb7eaeaa42367b39d16e9a2a9d968dbb0d3 Mon Sep 17 00:00:00 2001 From: doyasu24 Date: Mon, 11 Jul 2022 11:30:47 +0900 Subject: [PATCH] fix paths --- doc/DeployToControlTower.md | 22 +++++++++++----------- doc/HowTo.md | 4 ++-- doc/HowTo_ja.md | 4 ++-- doc/PipelineDeployment.md | 2 +- doc/PipelineDeployment_ja.md | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/DeployToControlTower.md b/doc/DeployToControlTower.md index 7acc91742..a2bc9cbaf 100644 --- a/doc/DeployToControlTower.md +++ b/doc/DeployToControlTower.md @@ -21,7 +21,7 @@ The steps to deploy are as follows: If you're just deploying, you don't need to We recommend that you set up a development environment, even if you are not doing serious development, to ensure safe editing of CDK code. The following are the steps to set up VisualStudioCode. -- [Instructions]: [VisualStudioCode Setup Instructions](doc/HowTo.md#VisualStudioCode-Setup-Instructions) +- [Instructions]: [VisualStudioCode Setup Instructions](HowTo.md#VisualStudioCode-Setup-Instructions) ### Implementation procedure under ControlTower @@ -83,7 +83,7 @@ Create a new account (guest account) using ControlTower. Configure Slack integration settings for security and monitoring event notifications for guest accounts. Create a channel in Slack for security notifications, and a channel for system monitoring notifications, and follow these steps to configure Chatbot. When you are done, make a note of the ID of the workspace (1) and the ID of the channel you want to notify (2) for later settings. -- [Instructions]: [Set up Slack for AWS ChatBot](doc/HowTo.md#set-up-slack-for-aws-chatbot) +- [Instructions]: [Set up Slack for AWS ChatBot](HowTo.md#set-up-slack-for-aws-chatbot) ### 3. Install Dependencies and Build Code (Local) @@ -105,7 +105,7 @@ npm ci Registers a hook to perform checks by Linter, Formatter, and Git-Secrets when committing to Git. Follow the steps below to set it up. It is not required if you are just deploying, but we recommend a setup for more secure development. -- [Instructions]: [Git pre-commit hook setup](doc/HowTo.md#Git-pre-commit-hook-setup) +- [Instructions]: [Git pre-commit hook setup](HowTo.md#Git-pre-commit-hook-setup) ### 4. Configure AWS CLI credentials for AWS SSO (Local) @@ -219,7 +219,7 @@ Only setting up AWS Chatbot is done in the management console, and any further w Log in to your Audit account in the management console and set up Slack Workspace on AWS Chatbot. We will only create one for the aggregation. Please refer to the steps below -- [Instructions]: [Set up Slack for AWS ChatBot](doc/HowTo.md#set-up-slack-for-aws-chatbot) +- [Instructions]: [Set up Slack for AWS ChatBot](HowTo.md#set-up-slack-for-aws-chatbot) #### 5-2. Set deployment information (Context) @@ -263,9 +263,9 @@ The contents of this setting are as follows. > NOTE: See the following explanation for how to use Context > -> - [Manage personal environment by cdk.context.json](doc/HowTo.md#Manage-personal-environment-by-cdkcontextjson) +> - [Manage personal environment by cdk.context.json](HowTo.md#Manage-personal-environment-by-cdkcontextjson) > -> - [Accessing context in application](doc/HowTo.md#accessing-context-in-application) +> - [Accessing context in application](HowTo.md#accessing-context-in-application) #### 5-3. Deploy a baseline for the Audit account @@ -297,7 +297,7 @@ You should now be notified of all AWS Config change events for accounts managed > > - Here we are using `npx` to use a local cdk installed in the BLEA environment. If you start the command directly from `cdk`, the globally installed cdk will be used. > -> - There are options that are useful when using the cdk command. See [Skip Deployment Approvals and Don't Roll Back](doc/HowTo.md#skip-deployment-approvals-and-dont-roll-back). +> - There are options that are useful when using the cdk command. See [Skip Deployment Approvals and Don't Roll Back](HowTo.md#skip-deployment-approvals-and-dont-roll-back). ### 6. Deploy a governance base for guest accounts (Local) @@ -378,7 +378,7 @@ npx cdk bootstrap -c environment=dev --profile ct-guest > > - Here we are using `npx` to use a local cdk installed in the BLEA environment. If you start the command directly from `cdk`, the globally installed cdk will be used. > -> - There are options that are useful when using the cdk command. See [Skip Deployment Approvals and Don't Roll Back](doc/HowTo.md#skip-deployment-approvals-and-dont-roll-back). +> - There are options that are useful when using the cdk command. See [Skip Deployment Approvals and Don't Roll Back](HowTo.md#skip-deployment-approvals-and-dont-roll-back). Deploy a governance base for guest accounts. @@ -474,11 +474,11 @@ This completes the baseline and sample application deployment for a single accou 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. -- [Development process](doc/HowTo.md#development-process) -- [Update package dependencies](doc/HowTo.md#update-package-dependencies) +- [Development process](HowTo.md#development-process) +- [Update package dependencies](HowTo.md#update-package-dependencies) #### 7-4. Remediation of security issues Even after deploying a governance base, there are detections that are reported at a critical or high severity level in Security Hub benchmark reports . You will need to take action on these manually. If necessary, perform remediation. -- [Remediate Security Issues](doc/HowTo.md#remediate-security-issues) +- [Remediate Security Issues](HowTo.md#remediate-security-issues) diff --git a/doc/HowTo.md b/doc/HowTo.md index 859965cc2..02961eca8 100644 --- a/doc/HowTo.md +++ b/doc/HowTo.md @@ -217,7 +217,7 @@ see: [https://docs.aws.amazon.com/cloudshell/latest/userguide/limits.html] ### 1. Start CloudShell - Launch CloudShell by clicking the [>_] icon in the AWS Management Console (next to your account name in the top right corner of the screen) - ! [OpenConsole](doc/images/CloudShell-OpenConsole.png) + ![OpenConsole](../doc/images/CloudShell-OpenConsole.png) ### 2. Set up the CDK execution environment @@ -233,7 +233,7 @@ sudo npm -g install npm 1. Download the CDK code to be deployed and archive it with zip, etc. 2. From the CloudShell screen, click [Action]-[Upload File] to upload the archived file - ![UploadFiles](doc/images/CloudShell-UploadFiles.png) + ![UploadFiles](../doc/images/CloudShell-UploadFiles.png) 3. Extract uploaded files diff --git a/doc/HowTo_ja.md b/doc/HowTo_ja.md index d78e12b51..f333f3617 100644 --- a/doc/HowTo_ja.md +++ b/doc/HowTo_ja.md @@ -217,7 +217,7 @@ see: [https://docs.aws.amazon.com/cloudshell/latest/userguide/limits.html] ### 1. CloudShell を起動する - AWS マネジメントコンソールの [>_] アイコンをクリックして CloudShell を起動する (画面右上のアカウント名の隣) - ![OpenConsole](doc/images/CloudShell-OpenConsole.png) + ![OpenConsole](../doc/images/CloudShell-OpenConsole.png) ### 2. CDK の実行環境をセットアップする @@ -233,7 +233,7 @@ sudo npm -g install npm 1. デプロイ対象の CDK コードをダウンロードし、zip 等でアーカイブする。 2. CloudShell の画面から [Action]-[Upload File] をクリックし、アーカイブしたファイルをアップロードする - ![UploadFiles](doc/images/CloudShell-UploadFiles.png) + ![UploadFiles](../doc/images/CloudShell-UploadFiles.png) 3. アップロードしたファイルを展開する diff --git a/doc/PipelineDeployment.md b/doc/PipelineDeployment.md index 9699eca4e..f612006cd 100644 --- a/doc/PipelineDeployment.md +++ b/doc/PipelineDeployment.md @@ -1,6 +1,6 @@ # Deploy CDK Application via CDK Pipelines -[View this page in Japanese (日本語)](README_ja.md) | [Back to Repository README](../../README.md) +[View this page in Japanese (日本語)](PipelineDeployment_ja.md) | [Back to Repository README](../README.md) As an example of CI/CD with CDK, this document shows how to use sample to deploy CDK Application via CDK Pipelines. diff --git a/doc/PipelineDeployment_ja.md b/doc/PipelineDeployment_ja.md index f13abfa93..4308c06b5 100644 --- a/doc/PipelineDeployment_ja.md +++ b/doc/PipelineDeployment_ja.md @@ -1,6 +1,6 @@ # CDK Pipelines を使用して guest-webapp-sample をデプロイする -[In English](PipelineDeployment.md) | [リポジトリの README に戻る](../../README_ja.md) +[In English](PipelineDeployment.md) | [リポジトリの README に戻る](../README_ja.md) CDK による CI/CD の一例として、このドキュメントでは [CDK Pipelines](https://docs.aws.amazon.com/cdk/v2/guide/cdk_pipeline.html) を用いてアプリケーションをデプロイするためのサンプルコードの使用方法を示します。