From 12bde981166716179b890bd4292b74abcaa288d0 Mon Sep 17 00:00:00 2001 From: Derek Graeber Date: Mon, 18 Dec 2023 11:54:20 -0500 Subject: [PATCH] uopdating docs - typo in manifest name definition --- CHANGELOG.md | 1 + docs/source/manifests.md | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index af2770d6..f9df4c6b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Ch ### Changes ### Fixes +- Docs - manifest name description (seed-farmer/docs/source/manifests.md) needed correction ## v3.0.1 (2023-11-10) diff --git a/docs/source/manifests.md b/docs/source/manifests.md index 70d5124d..e6d25f98 100644 --- a/docs/source/manifests.md +++ b/docs/source/manifests.md @@ -244,9 +244,10 @@ dataFiles: - filePath: test1.txt - filePath: git::https://github.com/awslabs/idf-modules.git//modules/storage/buckets/deployspec.yaml?ref=release/1.0.0&depth=1 ``` -- **name** - the name of the group +- **name** - the name of the module + - this name must be unique in the group of the deployment - **path** - this element supports two sources of code: - - the relative path to the module code in the project + - the relative path to the module code in the project if deploying code from the local filesystem - a public Git Repository, leveraging the Terraform semantic as denoted [HERE](https://www.terraform.io/language/modules/sources#generic-git-repository) - **targetAccount** - the alias of the account from the [deployment manifest mappings](deployment_manifest) - **targetRegion** - the name of the region to deploy to - this overrides any mappings