Better README #17
Better README #17
Conversation
There was a problem hiding this comment.
I think the example config/environment probably need more work before they should be leaned on too heavily. They've been neglected for a while now.
That said, we have a whole setup with stacker_cookiecutter, I'm wondering if we should just be pushing people towards that?
README.md
Outdated
|
|
||
| >NOTES: it will create aws resources and generate cost on your aws account. `make destroy` them all if not required any more. | ||
|
|
||
| Make sure you have permission to access aws, review below files if you need change anything. |
There was a problem hiding this comment.
Might need more information around permission to access aws - that's a pretty broad definition.
Also, should probably change the second sentence to: review the files below if you need to change anything.
README.md
Outdated
| Make sure you have permission to access aws, review below files if you need change anything. | ||
|
|
||
| 1) Adjust namespace to a global unique name, the name in example will be used in s3 bucket name, and has been used. | ||
| 2) I have issue to start with pre_build task, if you get same problem, comment that session. |
There was a problem hiding this comment.
We should probably just fix the pre_build task if there is an issue- can you share what problem you're seeing as an issue?
| @@ -6,4 +6,4 @@ | |||
| # will be used to prefix the CloudFormation stack names as well as the s3 | |||
| # bucket that contains revisions of the stacker templates. This is the only | |||
| # required environment variable. | |||
| namespace: | |||
| namespace: stacker_blueprints | |||
There was a problem hiding this comment.
If this is left blank, what error happens if you run this?
There was a problem hiding this comment.
I got this error
stacker.exceptions.InvalidConfig: {'namespace': ConversionError([ErrorMessage(u'This field is required.', None)])}
|
I have updated with your suggestion, please review again. |
README.md
Outdated
|
|
||
| An attempt at a common Blueprint library for use with `stacker <https://github.com/cloudtools/stacker>`_. | ||
|
|
||
| If you're new to stacker you may use `stacker_cookiecutter <https://github.com/cloudtools/stacker_cookiecutter>`_ to setup your project. |
There was a problem hiding this comment.
The Quickstart should reference the cookie cutter project.
README.mdparametersis not supported any more)