Skip to content

Commit

Permalink
docs: clarify s3 bucket deployment instructions (#630)
Browse files Browse the repository at this point in the history
* docs: clarify s3 bucket deployment instructions
* small doc fixes on deployment

---------

Co-authored-by: Bastien Leblanc <[email protected]>
  • Loading branch information
mridehalgh and BastLeblanc committed Sep 6, 2024
1 parent 10f84a6 commit cc12f15
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 14 deletions.
File renamed without changes.
29 changes: 16 additions & 13 deletions docs/Deployment/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,8 @@ git clone https://github.com/aws-samples/retail-demo-store
```

!!! Note
If you plan to customize the demo, we recommend using your fork
If you plan to customize the demo, we recommend using your fork instead of the aws-samples one (see [fork this repo](#optional-fork-this-repo))

## Install and configure the AWS CLI:

```
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip
sudo ./aws/install
aws configure
```

## Packages required for building staging:

Expand All @@ -63,6 +55,16 @@ sudo apt install nodejs
sudo apt install npm
```

## Install and configure the AWS CLI:

```
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip
sudo ./aws/install
aws configure
```


## (optional) Fork this Repo

We recommend to create a fork of the Retail Demo Store respository in your own GitHub account. That enables you to customize the code before deployment.
Expand All @@ -77,10 +79,10 @@ Save your access token in a secure location, you will use it the CloudFormation

## Step 2: Create a S3 Staging Bucket

We recommend to create a dedicated bucket for deployment with **versioning enabled.**
Create a dedicated S3 bucket specifically for staging/deployment, and ensure that [**versioning is enabled**](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) for this bucket.

!!! Note
Bucket Region: Your staging bucket must be in the **region** in which you plan to deploy the Retail Demo Store.
> [!IMPORTANT]
> Your staging bucket must be in the **region** with in which you plan to deploy the Retail Demo Store.
### Enabling Event Notifications

Expand Down Expand Up @@ -156,7 +158,8 @@ All the others will work by default, take the time to read and decide which para

!!!NOTE

You can also use the command line below. (replace REGION, MY_CUSTOM_BUCKET and S3_PATH value)
You can also use the command line below. (replace REGION, MY_CUSTOM_BUCKET and S3_PATH value).
This script deploys the retail demo store with standard options, you cannot change any parameters directly

```bash
./scripts/deploy-cloudformation-stacks.sh DEPLOYMENT_S3_BUCKET REGION STACK_NAME
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Personalization

[1 - Creating the Account](1-Creating-account.md) > 2 - Personalization
[1 - Creating the Account](../../Deployment/1-Creating-account.md) > 2 - Personalization

Personalized user experiences are implemented across several features within the Retail Demo Store web user interface that demonstrate three core use-cases of Amazon Personalize as well as real-time recommendations.

Expand Down

0 comments on commit cc12f15

Please sign in to comment.