Merge pull request #45 from cloudbees/issue-20

[Issue 20]: Completing the Documentation

README.md

@@ -2,7 +2,7 @@
 
 ![GitHub Latest Release)](https://img.shields.io/github/v/release/cloudbees/terraform-aws-cloudbees-ci-eks-addon?logo=github) ![GitHub Issues](https://img.shields.io/github/issues/cloudbees/terraform-aws-cloudbees-ci-eks-addon?logo=github) [![Code Quality: Terraform](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/terraform.yml/badge.svg?event=pull_request)](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/terraform.yml) [![Code Quality: Super-Linter](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/superlinter.yml/badge.svg?event=pull_request)](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/superlinter.yml) [![Documentation: MD Links Checker](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/md-link-checker.yml/badge.svg?event=pull_request)](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/md-link-checker.yml) [![Documentation: terraform-docs](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/terraform-docs.yml/badge.svg?event=pull_request)](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon/actions/workflows/terraform-docs.yml) [![gitleaks badge](https://img.shields.io/badge/protected%20by-gitleaks-blue)](https://github.com/zricethezav/gitleaks#pre-commit) [![gitsecrets](https://img.shields.io/badge/protected%20by-gitsecrets-blue)](https://github.com/awslabs/git-secrets)
 
-> Deploy CloudBees CI to AWS EKS Clusters with this add-on.
+Deploy CloudBees CI to AWS EKS Clusters with this add-on.
 
 ## Usage
 
@@ -32,7 +32,7 @@ Easing adoption of CloudBees CI by:
 - Using [AWS Terraform EKS Addons](https://aws-ia.github.io/terraform-aws-eks-blueprints-addons/main/) as the single point of truth for third-party EKS Addons. Note that some of the addons are required and others are optional.
 
 > [!NOTE]
-> For a better understading of the blueprints' scope, please read the section [Consumption](https://aws-ia.github.io/terraform-aws-eks-blueprints/#consumption) and [Terraform Caveats](https://aws-ia.github.io/terraform-aws-eks-blueprints/#terraform-caveats) in AWS the EKS blueprints documentation.
+> For a better understading of the AWS the EKS blueprints' scope, please read the section [Consumption](https://aws-ia.github.io/terraform-aws-eks-blueprints/#consumption) and [Terraform Caveats](https://aws-ia.github.io/terraform-aws-eks-blueprints/#terraform-caveats) in its documentation.
 
 ## CloudBees License
 

blueprints/01-getting-started/README.md

@@ -8,13 +8,18 @@ Get started with the CloudBees CI add-on by reviewing this example which deploys
   - [External DNS](https://aws-ia.github.io/terraform-aws-eks-blueprints-addons/main/addons/external-dns/)
   - [EBS CSI Driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html) to allocate EBS volumes for hosting [$JENKINS_HOME](https://docs.cloudbees.com/docs/cloudbees-ci/latest/backup-restore/jenkins-home).
 
+## Architecture
+
+![Architecture](architecture/getting-started.drawio.svg)
+
 ## Prerequisites
 
 ### Tooling
 
 The required tooling as described in the [Getting Started Guide - Prerequisites](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites)
 
-> **_NOTE:_** For contributing there is a dedicated page [CONTRIBUTING.md](../../CONTRIBUTING.md).
+> [!NOTE]
+> For contributing there is a dedicated page [CONTRIBUTING.md](../../CONTRIBUTING.md).
 
 ### AWS Authentication
 
@@ -69,14 +74,14 @@ These blueprints rely on an existing Hosted Zone in AWS Route53. If you don't ha
 
 ## Deploy
 
-First of all, customize your variables by copying `.auto.tfvars.example` to `.auto.tfvars`.
+First of all, customize your terraform values by copying `.auto.tfvars.example` to `.auto.tfvars`.
 
 Initialize the root module and any associated configuration for providers and finally create the resources and deploy CloudBees CI to an EKS Cluster. Please refer to [Getting Started - Amazon EKS Blueprints for Terraform - Deploy](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#deploy)
 
-In case, it is required to review the resources before applying the changes, remove the flag `-auto-approve` from the commands.
-
 For more detailed information, see the documentation for the [Terraform Core workflow](https://www.terraform.io/intro/core-workflow).
 
+TODO: Deloyed resources link to AWS Resource Groups
+
 > [!TIP]
 > These steps are automated in the [Makefile](../../Makefile) at the root of the project under the target `tfDeploy`.
 
@@ -131,7 +136,3 @@ To teardown and remove the resources created in the blueprint, the typical steps
 
 > [!TIP]
 > These steps are automated in the [Makefile](../../Makefile) at the root of the project under the target `tfDestroy`.
-
-## Architecture
-
-![Architecture](../diagrams/getting-started.drawio.png)