Merge pull request #468 from dgraeber/fix/module-docs-desc

uopdating docs - typo in manifest name definition
awslabs · Dec 18, 2023 · 3f43f84 · 3f43f84
2 parents 54eac1d + 12bde98
commit 3f43f84
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git 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
@@ -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