The documentation for --dir says:
Where to find specifications. Default is ..
The documentation about specifications says,
Specification files ("specs") have the following path structure:
stacks/{account-id}.{account-name}/{region}/{stack-name}.yaml
Users have indicated that does not clearly convey that Stackctl expects to be run in, or use a --dir that is, a directory containing ./stacks and ./templates.
. <-- HERE
├── stacks/
│ └── {account-id}.{account-name}/
│ └── {region}/
│ └── {stack-name}.yaml
│
└── templates/
└── {template}.yaml
Thus, they can make a few incorrect guesses:
- Be in the directory with
./{stack-name}.yaml, assuming the file is the specification and going by --dir documentation
- Be in the
stacks sub-directory
Be in the correct directory, but have the wrong AWS account active
We should rewrite these things to clarify that, and probably add an EXAMPLES section that makes it more concrete, and thus clearer.
The documentation for
--dirsays:The documentation about specifications says,
Users have indicated that does not clearly convey that Stackctl expects to be run in, or use a
--dirthat is, a directory containing./stacksand./templates.Thus, they can make a few incorrect guesses:
./{stack-name}.yaml, assuming the file is the specification and going by--dirdocumentationstackssub-directoryBe in the correct directory, but have the wrong AWS account activeWe should rewrite these things to clarify that, and probably add an
EXAMPLESsection that makes it more concrete, and thus clearer.