search

UCL-MIRSG / xnat-aws

Deploy XNAT on AWS
MIT License
2 stars 0 forks source link

Documentation in README.md #101

Closed davecash75 closed 3 months ago

davecash75 commented 3 months ago

Short Description

Under step 3 of the README.md it states:

cp terraform.tfvars.example terraform.tfvars

However the provision folder of xnat-aws, the file appears to be called terraform.tfvars_sample instead

Evidence/Steps to Reproduce

See README file

Acceptance Criteria/Expected Behaviour

Change to the documentation

Details

No response

Resolution

No response

davecash75 commented 3 months ago

Also @milanmlft you may want to put a prompt in for people that they need to put in the value true or false when prompted for AppStream. It wasn't clear from the instructions when I wrote terraform apply, so I wrote yes originally and got an error.

davecash75 commented 3 months ago

I see that the correct name terraform.tfvars_sample and mention of using true for Appstream is in the Provision README, but you may want to put it also in the main README as people might not see that before they go headlong into the terraform process. Also, we may want make people aware of if they click on AppStream, then they need to have an image accesible to them with the name in their terraform.tfvars. Otherwise it hangs.

ruaridhg commented 3 months ago

I'm going to update the docs with your comments @davecash75 and some of my own