GenU V3 (#806)

Co-authored-by: Taichiro Suzuki <taichirs@amazon.co.jp>
Co-authored-by: Taiki Maekawa <tmae@amazon.com>
Co-authored-by: Yusuke Wada <52243855+wadabee@users.noreply.github.com>

.github/pull_request_template.md

@@ -3,9 +3,10 @@
 既存ユーザーへの影響がある場合 (互換性・デグレ・破壊的変更など) は必ず説明に含めてください。
 
 ## チェック項目
-- [ ] npm run lint を実行した
+- [ ] `npm run lint` を実行した
 - [ ] 関連するドキュメントを修正した
 - [ ] 手元の環境で動作確認済み
+- [ ] `npm run cdk:test` を実行しスナップショット差分がある場合は `npm run cdk:test:update-snapshot` を実行してスナップショットを更新した
 
 ## 関連する Issue
 関連する Issue を可能な限り挙げてください。

.github/workflows/gh-pages.yml

@@ -0,0 +1,33 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '*.md'
+      - 'docs/**'
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements.txt
+      - run: mkdocs gh-deploy --force

.github/workflows/node.js.yml

@@ -20,6 +20,8 @@ jobs:
       matrix:
         node-version: [18.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    env:
+      CDK_DEFAULT_ACCOUNT: 123456789012
 
     steps:
       - uses: actions/checkout@v3
@@ -33,4 +35,5 @@ jobs:
       - run: npm run web:lint
       - run: npm run cdk:lint
       - run: npm run web:build
+      - run: npm run cdk:test
       - run: npm -w packages/cdk run cdk synth

.gitignore

@@ -3,4 +3,8 @@ node_modules
 
 !.gitkeep
 
-/*/dist/**
+/*/dist/**
+
+# MkDocs documentation
+site*/
+.cache

browser-extension/README.md

@@ -5,7 +5,7 @@
 > [!IMPORTANT]
 > このブラウザ拡張機能を利用するためには、GenU を事前にデプロイする必要があります。まずは、[こちら](https://github.com/aws-samples/generative-ai-use-cases-jp#%E3%83%87%E3%83%97%E3%83%AD%E3%82%A4)を参考にデプロイをしてください。
 
-![拡張機能イメージ](../imgs/extension/extension_demo.png)
+![拡張機能イメージ](../docs/assets/images/extension/extension_demo.png)
 
 ## Why Use ブラウザ拡張機能 ?
 

deploy.sh

@@ -53,7 +53,7 @@ fi
 npx -w packages/cdk cdk bootstrap
 
 # デプロイの実行
-npm run cdk:deploy
+npm run cdk:deploy:quick
 
 # デプロイした CloudFront の url を取得
 weburl=`aws cloudformation describe-stacks --stack-name GenerativeAiUseCasesStack --output json | jq -r ".Stacks[0].Outputs[] | select(.OutputKey==\"WebUrl\") | .OutputValue"`

docs/ABOUT.md

@@ -0,0 +1,3 @@
+{%
+    include-markdown "../README.md"
+%}

docs/DEPLOY_ON_AWS.md

@@ -2,7 +2,7 @@
 
 > [!Caution]
 > この手順は AWS Cloud9 が新規のお客様向けアクセスを閉じたことを受け、非推奨手順となりました。
-> AWS 上で完結するデプロイ方法については [CloudShell を利用したデプロイ方法](/docs/DEPLOY_ON_CLOUDSHELL.md) をご参照ください。
+> AWS 上で完結するデプロイ方法については [CloudShell を利用したデプロイ方法](./DEPLOY_ON_CLOUDSHELL.md) をご参照ください。
 > また、AWS Cloud9 からの移行については [こちら](https://aws.amazon.com/jp/blogs/news/how-to-migrate-from-aws-cloud9-to-aws-ide-toolkits-or-aws-cloudshell/) のブログをご参照ください。
 
 AWS CloudShell と AWS Cloud9 を利用することで、手元の環境に依存しないデプロイが可能です。(デプロイが AWS 上で完結します。)
@@ -39,7 +39,7 @@ npm run cdk:deploy
 
 ## デプロイオプションの設定変更
 
-`cloud9-for-prototyping/generative-ai-use-cases-jp/packages/cdk/cdk.json` を開き、context 内の項目を変更します。設定可能な内容については[こちら](/docs/DEPLOY_OPTION.md)をご参照ください。
+`cloud9-for-prototyping/generative-ai-use-cases-jp/packages/cdk/cdk.json` を開き、context 内の項目を変更します。設定可能な内容については[こちら](./DEPLOY_OPTION.md)をご参照ください。
 
 cdk.json の内容を変更したら、ファイルを保存して、`npm run cdk:deploy` を実行します。デプロイすることで設定変更が反映されます。
 
@@ -65,7 +65,7 @@ Cloud9 の Preview 機能を使うためには、localhost の 8080 ~ 8082 ポ
 sudo yum -y install jq
 ```
 
-その後は[こちら](/docs/DEVELOPMENT.md) の手順に従います。以下のコマンドを実行してください。
+その後は[こちら](./DEVELOPMENT.md) の手順に従います。以下のコマンドを実行してください。
 
 ```bash
 npm run web:devw

docs/DEPLOY_ON_CLOUDSHELL.md

@@ -3,7 +3,7 @@
 ## cdk.json の編集
 
 GenU では cdk.json の context 以下をカスタマイズすることで、デプロイオプションを指定できます。
-利用可能なデプロイオプションについては [デプロイオプション](/docs/DEPLOY_OPTION.md) をご参照ください。
+利用可能なデプロイオプションについては [デプロイオプション](./DEPLOY_OPTION.md) をご参照ください。
 一旦、[デフォルトの cdk.json](/packages/cdk/cdk.json) で構わないという場合は、こちらの手順をスキップしていただいて構いません。
 
 デプロイオプションを指定する場合は、[デフォルトの cdk.json](/packages/cdk/cdk.json) をダウンロード (GitHub ページ右上のダウンロードボタンからファイルをダウンロードできます) し、context 以下を変更してファイルを保存してください。