Should DEPLOYMENT_DIR be part of requirements?

cloudfoundry-attic / mega-ci

Scripts, templates, and configuration for the CF Infrastructure team's CI pipelines

https://mega.ci.cf-app.com/

Apache License 2.0

13 stars 7 forks source link

Should DEPLOYMENT_DIR be part of requirements? #8

Closed luan closed 9 years ago

luan commented 9 years ago

On the README, I was confused when Usage mentioned a PATH_TO_DEPLOYMENT_DIR. The lines below will explain what that is, but it took me a bit to figure out that it would explain it later, only to make me scroll back up later.

That flow could be improved for the reader.

cf-gitbot commented 9 years ago

We have created an issue in Pivotal Tracker to manage this. You can view the current status of your issue at: https://www.pivotaltracker.com/story/show/107091240.

Amit-PivotalLabs commented 9 years ago

I think this is specific to the CF tool. For the Concourse tool, it says:

Usage

./scripts/setup_aws_bosh_for_concourse PATH_TO_DEPLOYMENT_DIR

See Requirements below for an explanation of the DEPLOYMENT_DIR.

I'll update the story and prioritize it.

Amit-PivotalLabs commented 9 years ago

Thanks very much for this feedback @luan, we're marking this repo as being under heavy re-construction, and we'll incorporate this information in the new incarnation. (I'll copy-paste this message to the other issues you opened, for anyone in the future coming across any of them).