suggested edits on README #80
Conversation
README.md
Outdated
|
|
||
| Checks `.erb` files for syntax errors | ||
| The `app_management` setting is supported with Puppet 4.3 or greater and is off by default. |
There was a problem hiding this comment.
Add back in: With Puppet 5, app_management is always enabled.
README.md
Outdated
|
|
||
| - Puppet >= 2.7 that provides the `validate` face. | ||
| - Ruby >= 1.8 with `erb` from stdlib. | ||
| - Ruby >= 1.8 with `erb` from `puppetlabs-stdlib`. |
There was a problem hiding this comment.
Ruby's stdlib, not puppetlabs-stdlib (isn't it?).
There was a problem hiding this comment.
Oops, that makes sense, sorry!
README.md
Outdated
|
|
||
| If you are trying to validate the syntax of code written for application orchestration, you can enable the `app_management` setting: | ||
| task :test => [ |
There was a problem hiding this comment.
Formatting here is missing, more indentation is required.
|
Thank you for the review, @domcleal . I've updated my PR with those fixes. I squashed the commits, as that's usually what I do at work. But truth be told, I haven't contributed to community projects before, so I don't really know whether squashing them is proper etiquette or not. :-) |
jbondpdx
changed the title
README.md
Outdated
|
|
||
| Test all manifests and templates relative to your `Rakefile`: | ||
| $ gem 'puppet-syntax' |
There was a problem hiding this comment.
The $ should be removed, it shouldn't be in a Gemfile and isn't a command.
README.md
Outdated
|
|
||
| A non-zero exit code and error message will be returned for any failures: | ||
| $ bundle |
|
Thanks for the update, a couple more comments that I missed the first time. Squashing the changes is fine. |
|
Thank you, @domcleal , I've updated the PR. |
|
Merged, thanks @jbondpdx. |
Howdy!
As part of the work for the Puppet SDK, I'd like to submit some edits to the Puppet::Syntax README. I've edited and reorganized the README with best docs practices in mind; of please let me know if I've got something wrong or you'd like me to make adjustments.
Pinging @DavidS for visibility (also, he helped review my changes before this PR).