quota-monitor-for-aws icon indicating copy to clipboard operation
quota-monitor-for-aws copied to clipboard

README.md couple of improvements

Open kmturley opened this issue 4 years ago • 2 comments
trafficstars

There seems to be a missing command and some other improvements which could be made to improve the README.md file for new developers.

1) Remove newline characters

newline characters are not needed in bash:

cd ./deployment
chmod +x ./run-unit-tests.sh  \n
./run-unit-tests.sh \n

Should either be removed:

cd ./deployment
chmod +x ./run-unit-tests.sh
./run-unit-tests.sh

Or if intending to be a single multiline command:

cd ./deployment && \
  chmod +x ./run-unit-tests.sh && \
  ./run-unit-tests.sh

2) Include missing command

It is not clear which dist folder this refers to:

aws s3 cp ./dist/ s3://my-bucket-name/limit-monitor/latest/ --recursive --exclude "*" --include "*.template" --acl bucket-owner-full-control --profile aws-cred-profile-name

Would be better to include the cd command to make it clear:

cd ../source/lambda/services/limitreport
aws s3 cp ./dist/ s3://my-bucket-name/limit-monitor/latest/ --recursive --exclude "*" --include "*.template" --acl bucket-owner-full-control --profile aws-cred-profile-name

Or if we can pass through relative paths this would be clearer:

aws s3 cp ../source/lambda/services/limitreport/dist/ s3://my-bucket-name/limit-monitor/latest/ --recursive --exclude "*" --include "*.template" --acl bucket-owner-full-control --profile aws-cred-profile-name

kmturley avatar Dec 30 '20 23:12 kmturley

Even more confusing my assets were built into global-s3-assets for templates and regional-s3-assets for the lambda zips. So not sure why ./dist is mentioned at all. It seems like the command would be: aws s3 cp ./global-s3-assets/ s3://my-bucket-name/limit-monitor/latest/ --recursive --exclude "*" --include "*.template" --acl bucket-owner-full-control --profile aws-cred-profile-name

cchanley2003 avatar May 22 '21 23:05 cchanley2003

@cchanley2003 Yea make sense. The path they mention is for Dist folders and I'm not sure if it's required. Someone please clarify @kmturley

Thrinadh-Kumpatla avatar Jul 29 '21 11:07 Thrinadh-Kumpatla

updated in v6.0.0

gsingh04 avatar Oct 12 '22 20:10 gsingh04