Skip to content

Commit fbf9585

Browse files
Merge pull request #176 from ably/fix/INF-3250-Update-Terraform-Documentation
[INF-3250] - Update Contributing and Provider documentation
2 parents b355d3c + 89d429e commit fbf9585

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

CONTRIBUTING.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
## Contributing
44

55
1. Fork it
6-
3. Create your feature branch (`git checkout -b my-new-feature`)
7-
4. Commit your changes (`git commit -am 'Add some feature'`)
8-
5. Ensure you have added suitable tests and the test suite is passing
9-
8. Push the branch (`git push origin my-new-feature`)
10-
9. Create a new Pull Request
6+
2. Create your feature branch (`git checkout -b my-new-feature`)
7+
3. Commit your changes (`git commit -am 'Add some feature'`)
8+
4. Ensure you have added suitable tests and the test suite is passing
9+
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)
10+
6. Push the branch (`git push origin my-new-feature`)
11+
7. Create a new Pull Request
1112

1213
## Release Process
1314

docs/resources/api_key.md

+4
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ resource "ably_api_key" "api_key_1" {
3333
- `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)
3434
- `name` (String) The name for your API key. This is a friendly name for your reference.
3535

36+
### Optional
37+
38+
- `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)
39+
3640
### Read-Only
3741

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

0 commit comments

Comments
 (0)