diff --git a/mkdocs.yml b/mkdocs.yml index 6a6a4a796..c6e15ceee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,8 +14,8 @@ nav: - Getting started: - Pre-requisites: docs/getting-started/pre-requisites.md - How to install: docs/getting-started/installation.md - - Set up Credentials: docs/getting-started/setup-creds.md - - Set up custom workspace: docs/getting-started/custom-workspace.md + - Set up credentials: docs/getting-started/setup-creds.md + - Set up a custom workspace: docs/getting-started/custom-workspace.md - Deploy "Hello World": docs/getting-started/run-tool.md - Support matrix: docs/support.md - Commands: diff --git a/site/content/docs/getting-started/custom-workspace.md b/site/content/docs/getting-started/custom-workspace.md index 954133e34..18b25383a 100644 --- a/site/content/docs/getting-started/custom-workspace.md +++ b/site/content/docs/getting-started/custom-workspace.md @@ -1,4 +1,4 @@ -# Set up custom workspace +# Set up a custom workspace The default workspace used by AWS.Deploy.Tools is `$USERPROFILE/.aws-dotnet-deploy` on Windows and `$USER/.aws-dotnet-deploy` on Unix based OS. This workspace is used to create the CDK project and any other temporary files used by the tool. diff --git a/site/content/docs/getting-started/setup-creds.md b/site/content/docs/getting-started/setup-creds.md index 6a6b36902..8c2e19d0c 100644 --- a/site/content/docs/getting-started/setup-creds.md +++ b/site/content/docs/getting-started/setup-creds.md @@ -1,4 +1,4 @@ -# Setting up credentials +# Set up credentials AWS.Deploy.Tools internally uses a variety of different tools and services to host your .NET application on AWS. To run the AWS Deploy Tool, you must configure a credential profile that provides access to the AWS account you wish to deploy to. Your credentials must have permissions for certain services, depending on the tasks that you're trying to perform. @@ -12,7 +12,7 @@ The following are some examples of the typical permissions that are required. | --- | --- |--- | |deploy | Deploying to Amazon ECS | AWSCloudFormationFullAccess, AmazonECS_FullAccess, AmazonEC2ContainerRegistryFullAccess, AmazonSSMFullAccess, IAMFullAccess | |deploy | Deploying to AWS App Runner| AWSCloudFormationFullAccess, AWSAppRunnerFullAccess, AmazonEC2ContainerRegistryFullAccess, AmazonSSMFullAccess, IAMFullAccess| -|deploy | Deploying to AWS Elastic Beanstalk (deploy) | AWSCloudFormationFullAccess, AdministratorAccess-AWSElasticBeanstalk, AmazonSSMFullAccess, AmazonS3FullAccess (*required to upload the application bundle*), IAMFullAccess | +|deploy | Deploying to AWS Elastic Beanstalk | AWSCloudFormationFullAccess, AdministratorAccess-AWSElasticBeanstalk, AmazonSSMFullAccess, AmazonS3FullAccess (*required to upload the application bundle*), IAMFullAccess | |deploy | Hosting WebAssembly Blazor App in Amazon S3 & Amazon CloudFront | AmazonS3FullAccess, CloudFrontFullAccess, IAMFullAccess, AmazonSSMFullAccess, AWSLambda_FullAccess (*required to copy from CDKBootstrap bucket to S3 bucket*)| | list-deployments | List AWS CloudFormation stacks| AWSCloudFormationReadOnlyAccess | | delete-deployment | Delete an AWS CloudFormation stack | AWSCloudFormationFullAccess + permissions for resources being deleted |