Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Remove whitespace, add hint for the `DEVELOPING_LOCALLY.md` file.
  • Loading branch information
surminus committed Aug 13, 2024
1 parent 0197130 commit 1a58b3c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
6. Push the branch (`git push origin my-new-feature`)
7. Create a new Pull Request

## Testing

See [DEVELOPING_LOCALLY.md](DEVELOPING_LOCALLY.md) for guidance on performing acceptance tests.

## Release Process

1. Merge all pull requests containing changes intended for this release to `main` branch
Expand Down
2 changes: 1 addition & 1 deletion DEVELOPING_LOCALLY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ provider_installation {
}
```

Build your changes from the repository root with
Build your changes from the repository root with
```
$ go install
$ cd examples/playground && terraform plan
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ provider "ably" {
}
```

4. (Optional) Alternatively you can also specify Control API token in the provider configuration directly:
4. (Optional) Alternatively you can also specify Control API token in the provider configuration directly:

```terraform
provider "ably" {
Expand All @@ -50,7 +50,7 @@ provider "ably" {

## Using Ably Terraform provider

This readme gives a basic example; for more examples see the [examples/](examples/) folder, rendered documentation on the Terraform Registry, or [docs folder](docs/) in this repository.
This readme gives a basic example; for more examples see the [examples/](examples/) folder, rendered documentation on the Terraform Registry, or [docs folder](docs/) in this repository.


```terraform
Expand Down Expand Up @@ -84,7 +84,7 @@ resource "ably_queue" "example_queue" {

## Dependencies

This provider uses [Ably Control API](https://ably.com/docs/api/control-api) and [Ably Control Go SDK](https://github.com/ably/ably-control-go) under the hood.
This provider uses [Ably Control API](https://ably.com/docs/api/control-api) and [Ably Control Go SDK](https://github.com/ably/ably-control-go) under the hood.


## Support, feedback and troubleshooting
Expand Down

0 comments on commit 1a58b3c

Please sign in to comment.