Sha256: 98cec09d01b62653b5145af7e2de1165c42008cefd600d292cd75ea43f71db59

Contents?: true

Size: 782 Bytes

Versions: 33

Compression:

Stored size: 782 Bytes

Contents

# Contributing

## Add new resource type (ex. Redshift resource)

1. Create your feature branch (`git checkout -b add-type-redshift`)
2. Generate template files (`bundle exec ./lib/awspec/bin/toolbox template redshift`)
3. Fill files with code.
4. Generate [doc/resource_types.md](doc/resource_types.md) (`bundle exec ./lib/awspec/bin/toolbox docgen > doc/resource_type.md`)
5. Run test (`bundle exec rake spec`)
6. Push to the branch (`git push origin add-type-redshift`)
7. Create a new Pull Request

## Append resource type document (ex. VPC resource `be_available`)

1. Create vpc.md (`touch doc/_resource_types/vpc.md`)
2. Write following document.

<pre>
### be_available
(Write cool description)
```ruby
describe vpc('my-vpc') do
   it { should be_available }
end
```
</pre>

Version data entries

33 entries across 33 versions & 1 rubygems

Version Path
awspec-0.26.1 doc/contributing.md
awspec-0.26.0 doc/contributing.md
awspec-0.25.3 doc/contributing.md
awspec-0.25.2 doc/contributing.md
awspec-0.25.1 doc/contributing.md
awspec-0.25.0 doc/contributing.md
awspec-0.24.2 doc/contributing.md
awspec-0.24.1 doc/contributing.md
awspec-0.24.0 doc/contributing.md
awspec-0.23.0 doc/contributing.md
awspec-0.22.1 doc/contributing.md
awspec-0.22.0 doc/contributing.md
awspec-0.21.6 doc/contributing.md
awspec-0.21.5 doc/contributing.md
awspec-0.21.4 doc/contributing.md
awspec-0.21.3 doc/contributing.md
awspec-0.21.2 doc/contributing.md
awspec-0.21.1 doc/contributing.md
awspec-0.21.0 doc/contributing.md
awspec-0.20.2 doc/contributing.md