Skip to content

Commit

Permalink
Merge pull request #176 from ably/fix/INF-3250-Update-Terraform-Docum…
Browse files Browse the repository at this point in the history
…entation

[INF-3250] - Update Contributing and Provider documentation
  • Loading branch information
graham-russell authored Feb 9, 2024
2 parents b355d3c + 89d429e commit fbf9585
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
## Contributing

1. Fork it
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Ensure you have added suitable tests and the test suite is passing
8. Push the branch (`git push origin my-new-feature`)
9. Create a new Pull Request
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Ensure you have added suitable tests and the test suite is passing
5. Ensure that `tfplugindocs` has been run and that the Ably Terraform provider documentation is up to date. Terraform Plugin Docs tool is available [HERE](https://github.com/hashicorp/terraform-plugin-docs)
6. Push the branch (`git push origin my-new-feature`)
7. Create a new Pull Request

## Release Process

Expand Down
4 changes: 4 additions & 0 deletions docs/resources/api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ resource "ably_api_key" "api_key_1" {
- `capabilities` (Map of Set of String) The capabilities that this key has. More information on capabilities can be found in the [Ably documentation](https://ably.com/docs/core-features/authentication#capabilities-explained)
- `name` (String) The name for your API key. This is a friendly name for your reference.

### Optional

- `revocable_tokens` (Boolean) Allow tokens issued by this key to be revoked. More information on Token Revocation can be found in the [Ably documentation](https://ably.com/docs/auth/revocation)

### Read-Only

- `created` (Number) Enforce TLS for all connections. This setting overrides any channel setting.
Expand Down

0 comments on commit fbf9585

Please sign in to comment.