From 0762725fc8616d6f9e84d2dd34d394be360fd0db Mon Sep 17 00:00:00 2001
From: arnol377 <david.j.arnold.jr@census.gov>
Date: Thu, 6 Feb 2025 18:31:39 -0500
Subject: [PATCH] Refactor README.md to provide a detailed overview of the AWS
 Image Pipeline and its directories and repositories

---
 README.md                                     | 41 ++++++++++++++-----
 ...space => aws-image-pipeline.code-workspace |  6 +--
 2 files changed, 32 insertions(+), 15 deletions(-)
 rename linux-images.code-workspace => aws-image-pipeline.code-workspace (82%)

diff --git a/README.md b/README.md
index 1c74ea4..c5cb03f 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,31 @@
-# aws-image-pipeline
-Terraform Workspace for creating and managing AWS Image Pipelines.
-
-This project leverages at least 4 other repositories.
-## linux-image-pipeline
-[linux-image-pipeline](https://github.e.it.census.gov/CSVD/linux-image-pipeline)
-This repo contains packer configuration files for our 
-## image-pipeline-ansible-playbooks
-## terraform-aws-image-pipeline
-## image-pipeline-goss-testing
\ No newline at end of file
+# AWS Image Pipeline
+
+This repository is part of a larger project that involves multiple repos, each serving a specific purpose in the image pipeline process. Below is an overview of each directory and its role in the pipeline.
+
+Using VS Code you can open the linux-
+## Directories
+
+### [aws-image-pipeline](.)
+This is the main directory for the AWS Image Pipeline. It contains the core scripts and configurations required to manage the image pipeline process.
+
+### [ansible/ansible-playbooks](../image-pipeline-ansible-playbooks)
+This directory contains Ansible playbooks used for provisioning and configuring the images. These playbooks automate the setup and configuration of the images to ensure they meet the required specifications.
+
+### [packer/linux-image-pipeline](../linux-image-pipeline)
+This directory contains Packer templates and scripts used to build the Linux images. Packer is used to create machine images for multiple platforms from a single source configuration.
+
+### [modules/terraform-aws-image-pipeline](../terraform-aws-image-pipeline)
+This directory contains Terraform modules used to manage the infrastructure for the image pipeline on AWS. Terraform is used to provision and manage the AWS resources required for the image pipeline.
+
+### [test/goss-testing](../image-pipeline-goss-testing)
+This directory contains Goss tests used to validate the images. Goss is a YAML-based tool for validating server configurations, ensuring that the images meet the required standards before they are deployed.
+
+## Repositories
+
+- [aws-image-pipeline](https://git.e.it.census.gov/csvd/aws-image-pipeline)
+- [ansible/ansible-playbooks](https://git.e.it.census.gov/csvd/image-pipeline-ansible-playbooks)
+- [packer/linux-image-pipeline](https://git.e.it.census.gov/csvd/linux-image-pipeline)
+- [modules/terraform-aws-image-pipeline](https://github.com/HappyPathway/terraform-aws-image-pipeline)
+- [test/goss-testing](https://git.e.it.census.gov/csvd/image-pipeline-goss-testing)
+
+Each repository is integral to the overall image pipeline process, ensuring that images are built, configured, validated, and deployed efficiently and reliably.
\ No newline at end of file
diff --git a/linux-images.code-workspace b/aws-image-pipeline.code-workspace
similarity index 82%
rename from linux-images.code-workspace
rename to aws-image-pipeline.code-workspace
index 5066531..333ce78 100644
--- a/linux-images.code-workspace
+++ b/aws-image-pipeline.code-workspace
@@ -16,14 +16,10 @@
 			"path": "../terraform-aws-image-pipeline",
 			"name": "modules/terraform-aws-image-pipeline"
 		},
-		{
-			"path": "../terraform-url-downloader",
-			"name": "modules/terraform-url-downloader"
-		},
 		{
 			"path": "../image-pipeline-goss-testing",
 			"name": "test/goss-testing"
-		},
+		}
 	],
 	"settings": {
 	}