[#55] Move the deploy doc in the generated project

README.md

@@ -10,9 +10,7 @@ An infrastructure template for web applications powered by Terraform.
 
 ![Diagram of the Complete Infrastructure](https://github.com/nimblehq/infrastructure-templates/blob/feature/55-add-documentation/img/diagram_complete.png?raw=true)
 
-# Usage
-
-## Generate a new project
+## Usage
 
 ```bash
 npm install -g @nimblehq/infra-template
@@ -26,71 +24,6 @@ or
 npx @nimblehq/infra-template generate {project-name}
 ```
 
-## Deploy your infrastructure
-
-You can deploy your infrastructure with the [terraform CLI](https://learn.hashicorp.com/collections/terraform/cli) (`brew install terraform`), or directly using the [Terraform Cloud](https://cloud.hashicorp.com/products/terraform).
-
-This template remains generic to provide more flexibility.
-A workspace and folder strategy needs to be defined first:
-- What resources need to be global?
-- What resources need to be specific to an environment?
-- What workspaces will you need?
-
-While advanced users won't need it, the next part provides a "starter kit" architecture that suits most of the new projects.
-
-## Starter kit
-
-The starter kit has 3 workspaces:
-- **Shared**, that handles a single ECR (Elastic Container Registry) for the whole infrastructure
-- **Staging** and **Prod**: Both workspaces are similar but use different resource names (using the suffixes `-staging` and `-prod`)
-
-### Step 1, Source Code
-
-In the source code:
-- create a `base` and a `shared` folder.
-- move the `main.tf`, `outputs.tf` and `variables.tf` into the `base` folder.
-- create 3 empty files (`main.tf`, `outputs.tf` and `variables.tf`) in the `shared` folder.
-- extract from the `base/*` files all data related to `ECR`.
-
-### Step 2, AWS Access Key
-
-For Terraform to push your changes into AWS, it needs an access key. There are 2 options for that:
-- Using Terraform Cloud: configure the `aws_access_key` and `aws_secret_key` as sensitive variables in your Terraform Cloud Workspaces. Then add the reference into the source code:
-  ```
-  // base/main.tf && shared/main.tf
-  provider "aws" {
-    region     = var.region
-    access_key = var.aws_access_key // To be added
-    secret_key = var.aws_secret_key // To be added
-
-    default_tags {
-      tags = {
-        Environment = var.environment
-        Owner       = var.owner
-      }
-    }
-  }
-  ```
-- Using the `terraform` cli: You first need to install the `aws` CLI. Then run `aws configure` and enter your keys when prompt.
-  Note that this will store your key unencrypted in your file system. You want to ensure your workstation has an encrypted disk and strong password!
-
-### Step 3: workspaces
-
-_Workspaces can be managed in the terraform cloud or using the CLI._
-
-- Create a workspace named `{project-slug}-shared`
-  - Map it to the repository
-  - In the advanced configuration, ensure to configure your `VCS branch` with your current Git branch and the `Terraform Working Directory` as `shared`
-  - A list of variables (parsed from your source code) is available for input immediately. It does not enable inputting "sensitive" variables, so consider adding the sensitive variables later.
-  - Once done, navigate to the workspace homepage, then the "Variables" tab. Add the missing variables if any.
-  - You can now `Plan`, and, if successful, `Apply` the configuration in this workspace. The ECR should be created in AWS!
-- Create a workspace named `{project-slug}-staging`
-  - Follow the same steps, but this time, configure the `Terraform Working Directory` as `base`
-  - When inputting the variables, adjust the `namespace` and `environment` with the `-staging` suffix.
-- Last, create the `{project-slug}-prod` workspace. Follow the steps for the `{project-slug}-staging` workspace but use the `-prod` suffix instead of the `-staging` one.
-
-> 💡 Other variables might change from `staging` to `prod`, such as the DB credentials. Consider reviewing all the available variables and their descriptions.
-
 ## License
 
 This project is Copyright (c) 2014 and onwards Nimble. It is free software and may be redistributed under the terms specified in the [LICENSE] file.

skeleton/aws/README.md

@@ -0,0 +1,84 @@
+## Deploy your infrastructure
+
+You can deploy your infrastructure with the [terraform CLI](https://learn.hashicorp.com/collections/terraform/cli) (`brew install terraform`), or directly using the [Terraform Cloud](https://cloud.hashicorp.com/products/terraform).
+
+This template remains generic to provide more flexibility.
+A workspace and folder strategy needs to be defined first:
+- What resources need to be global?
+- What resources need to be specific to an environment?
+- What workspaces will you need?
+
+While advanced users won't need it, the next part provides a "starter kit" architecture that suits most of the new projects.
+
+## Starter kit
+
+The starter kit has 3 workspaces:
+- **Shared**, that handles a single ECR (Elastic Container Registry) for the whole infrastructure
+- **Staging** and **Prod**: Both workspaces are similar but use different resource names (using the suffixes `-staging` and `-prod`)
+
+### Step 1, Source Code
+
+In the source code:
+- create a `base` and a `shared` folder.
+- move the `main.tf`, `outputs.tf` and `variables.tf` into the `base` folder.
+- create 3 empty files (`main.tf`, `outputs.tf` and `variables.tf`) in the `shared` folder.
+- extract from the `base/*` files all data related to `ECR`.
+
+### Step 2, AWS Access Key
+
+For Terraform to push your changes into AWS, it needs an access key. There are 2 options for that:
+- Using Terraform Cloud: configure the `aws_access_key` and `aws_secret_key` as sensitive variables in your Terraform Cloud Workspaces. Then add the reference into the source code:
+  ```
+  // base/main.tf && shared/main.tf
+  provider "aws" {
+    region     = var.region
+    access_key = var.aws_access_key // To be added
+    secret_key = var.aws_secret_key // To be added
+
+    default_tags {
+      tags = {
+        Environment = var.environment
+        Owner       = var.owner
+      }
+    }
+  }
+  ```
+- Using the `terraform` cli: You first need to install the `aws` CLI. Then run `aws configure` and enter your keys when prompt.
+  Note that this will store your key unencrypted in your file system. You want to ensure your workstation has an encrypted disk and strong password!
+
+### Step 3: workspaces
+
+_Workspaces can be managed in the terraform cloud or using the CLI._
+
+- Create a workspace named `{project-slug}-shared`
+  - Map it to the repository
+  - In the advanced configuration, ensure to configure your `VCS branch` with your current Git branch and the `Terraform Working Directory` as `shared`
+  - A list of variables (parsed from your source code) is available for input immediately. It does not enable inputting "sensitive" variables, so consider adding the sensitive variables later.
+  - Once done, navigate to the workspace homepage, then the "Variables" tab. Add the missing variables if any.
+  - You can now `Plan`, and, if successful, `Apply` the configuration in this workspace. The ECR should be created in AWS!
+- Create a workspace named `{project-slug}-staging`
+  - Follow the same steps, but this time, configure the `Terraform Working Directory` as `base`
+  - When inputting the variables, adjust the `namespace` and `environment` with the `-staging` suffix.
+- Last, create the `{project-slug}-prod` workspace. Follow the steps for the `{project-slug}-staging` workspace but use the `-prod` suffix instead of the `-staging` one.
+
+> 💡 Other variables might change from `staging` to `prod`, such as the DB credentials. Consider reviewing all the available variables and their descriptions.
+
+## License
+
+This project is Copyright (c) 2014 and onwards Nimble. It is free software and may be redistributed under the terms specified in the [LICENSE] file.
+
+[LICENSE]: /LICENSE
+
+## About
+
+![Nimble](https://assets.nimblehq.co/logo/dark/logo-dark-text-160.png)
+
+This project is maintained and funded by Nimble.
+
+We ❤️ open source and do our part in sharing our work with the community!
+See [our other projects][community] or [hire our team][hire] to help build your product.
+Want to join? [Check out our jobs][jobs]!
+
+[community]: https://github.com/nimblehq
+[hire]: https://nimblehq.co/
+[jobs]: https://jobs.nimblehq.co/

src/templates/aws/addons/common.ts

@@ -2,7 +2,7 @@ import { AwsOptions } from '..';
 import { copy } from '../../../helpers/file';
 
 const applyCommon = ({ projectName }: AwsOptions) => {
-  const filesToCopy = ['main.tf', 'outputs.tf', 'providers.tf', 'variables.tf'];
+  const filesToCopy = ['main.tf', 'outputs.tf', 'providers.tf', 'variables.tf', 'README.md'];
 
   filesToCopy.forEach((fileName) => {
     copy(`aws/${fileName}`, fileName, projectName);