cur-setup-destination Readme a bit confusing
Opened this issue · 4 comments
The cur-setup-destination README example usage shows both the setup-source and setup-destination modules being called. But if you follow the deployment steps the setup-destination would have already been run in step 1 (cur-setup-destination)
@sean-nixon please can you check this?
@mthwbarb The README you linked for the cur-setup-destination module only contains the cur-setup-destination in the example. Can you clarify where the confusion lies? If there's a way we can make the documentation better, I'd love to hear suggestions.
The README for each module is intended to be more or less standalone documentation for just that one module. The top-level README contains instructions and examples for using all of the modules together to setup CUR and deploy CID dashboards.
Hi @sean-nixon - I'm referring to the example usage in the CUR SOURCE readme https://github.com/aws-samples/aws-cudos-framework-deployment/blob/main/terraform-modules/cur-setup-source/README.md. In this example, both modules are being provisioned. However, in the deployment steps from the workshop, you would typically deploy CUR DESTINATION first, then CUR SOURCE second, Especially if they are 2 different accounts and you are using 2 different sets of credentials to deploy.
I think the main README is ok but I would remove the CUR DESTINATION module reference from the example in CUR SOURCE readme.
@mthwbarb Sorry for the delay. I agree with your proposal. I've submitted a PR with some enhancements including removing the CUR destination module from the CUR source module example as well as adding a callout to refer to the main README for complete deployment instructions. Thanks for your feedback!