From 7ecb985e7ef5cdaa8ca4e259ccc58531ccf2aea3 Mon Sep 17 00:00:00 2001 From: Taylor Beseda Date: Thu, 15 Aug 2024 17:24:34 -0600 Subject: [PATCH] add create-aws-credentials to navigation --- .../docs/en/get-started/detailed-aws-setup.md | 2 +- .../get-started/project-files-and-folders.md | 18 ------------------ .../create-aws-credentials.md | 0 .../guides/developer-experience/deployment.md | 4 +++- src/views/docs/table-of-contents.mjs | 2 +- 5 files changed, 5 insertions(+), 21 deletions(-) delete mode 100644 src/views/docs/en/get-started/project-files-and-folders.md rename src/views/docs/en/{get-started => guides/developer-experience}/create-aws-credentials.md (100%) diff --git a/src/views/docs/en/get-started/detailed-aws-setup.md b/src/views/docs/en/get-started/detailed-aws-setup.md index 6a528564..9e07d823 100644 --- a/src/views/docs/en/get-started/detailed-aws-setup.md +++ b/src/views/docs/en/get-started/detailed-aws-setup.md @@ -54,7 +54,7 @@ runtime python ### Credentials -You'll need an Amazon Web Services account and credentials set up on your development machine and / or CI systems. If you don't yet have credentials on your development machine (like from [configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)), here's a guide for [gathering credentials from the AWS Console](./create-aws-credentials). +You'll need an Amazon Web Services account and credentials set up on your development machine and / or CI systems. If you don't yet have credentials on your development machine (like from [configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)), here's a guide for [gathering credentials from the AWS Console](../guides/developer-experience/create-aws-credentials). In the context of a deployment tool, Architect requires account credentials with IAM `AdministratorAccess` privileges. In turn, Architect will create and attach least-privilege IAM roles to runtime resources within your application, ensuring strict security boundaries by default. diff --git a/src/views/docs/en/get-started/project-files-and-folders.md b/src/views/docs/en/get-started/project-files-and-folders.md deleted file mode 100644 index 79267a3b..00000000 --- a/src/views/docs/en/get-started/project-files-and-folders.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Project files & folders -category: Get started -description: Architect project structure -sections: - - "Overview" - - "Creating new resources & files" - - "Special files & folders" - - "Custom paths" ---- - -## Overview - -## Creating new resources & files - -## Special files & folders - -## Custom paths diff --git a/src/views/docs/en/get-started/create-aws-credentials.md b/src/views/docs/en/guides/developer-experience/create-aws-credentials.md similarity index 100% rename from src/views/docs/en/get-started/create-aws-credentials.md rename to src/views/docs/en/guides/developer-experience/create-aws-credentials.md diff --git a/src/views/docs/en/guides/developer-experience/deployment.md b/src/views/docs/en/guides/developer-experience/deployment.md index 8537ea21..deaedad1 100644 --- a/src/views/docs/en/guides/developer-experience/deployment.md +++ b/src/views/docs/en/guides/developer-experience/deployment.md @@ -4,7 +4,9 @@ category: Developer experience description: How to deploy your Architect app --- -Architect makes deploying AWS CloudFormation "stacks" painless. +Architect makes deploying AWS CloudFormation "stacks" painless. +AWS credentials are required to deploy. +Learn about [AWS setup](../../get-started/detailed-aws-setup) and [gathering credentials from the AWS Console](./create-aws-credentials) > 🧑‍🏫 CloudFormation stack identifiers are created from the name specified in the `@app` pragma and are unique to an AWS region. Changing the project name or region will create a new CF stack. diff --git a/src/views/docs/table-of-contents.mjs b/src/views/docs/table-of-contents.mjs index 10bc8772..ef09d5d6 100644 --- a/src/views/docs/table-of-contents.mjs +++ b/src/views/docs/table-of-contents.mjs @@ -2,7 +2,6 @@ const GetStarted = [ 'Why Architect', 'Quickstart', 'Project manifest', - // 'Project files & folders', 'Detailed AWS setup', 'Runtime support', ] @@ -20,6 +19,7 @@ const Guides = [ 'Using TypeScript', 'Using Deno', 'Custom CloudFormation', + 'Create AWS credentials', { 'Continuous integration': [ 'GitHub Actions',