diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2f12856 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +## Development Flow + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Run ```terraform fmt``` +5. Push to the branch (`git push origin my-new-feature`) +6. Create a new Pull Request + +### Code Standard + +Run ```terraform fmt``` to ensure that your terraform code follows canonical format and style before submitting your pull request. + +### Supported Platforms + +This terraform module is for provisioning AWS infrastructure only. diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..6ce8999 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1 @@ +This repository is owned by the Ably Infrastructure team. diff --git a/README.md b/README.md index 796a3cb..acb8a33 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +# [Ably](https://www.ably.io) + +\_[Ably](https://ably.com) is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale. For more information, see the [Ably documentation](https://ably.com/documentation).\_ + # Ably Privatelink DNS Use this module to configure custom AWS Route53 DNS Records for using Ably over AWS PrivateLink. \*\*NOTE:\*\* You need an active Ably account and will need to engage with Ably's Partner & SRE teams to make use of this module. It will also require discussions about TLS certificates. @@ -91,6 +95,16 @@ variable "region_config" { } ``` +## Support, feedback and troubleshooting + +Please visit http://support.ably.io/ for access to our knowledgebase and to ask for any assistance. + +You can also view the community reported Github issues. + +## Contributing + +For guidance on how to contribute to this project, see [CONTRIBUTING.md](CONTRIBUTING.md). + ## Requirements | Name | Version | diff --git a/main.tf b/main.tf index ba9c1c4..7c9ac78 100644 --- a/main.tf +++ b/main.tf @@ -1,4 +1,8 @@ /** + * # [Ably](https://www.ably.io) + * + * _[Ably](https://ably.com) is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale. For more information, see the [Ably documentation](https://ably.com/documentation)._ + * * # Ably Privatelink DNS * Use this module to configure custom AWS Route53 DNS Records for using Ably over AWS PrivateLink. * **NOTE:** You need an active Ably account and will need to engage with Ably's Partner & SRE teams to make use of this module. It will also require discussions about TLS certificates. @@ -91,7 +95,17 @@ * } * } * ``` -*/ + * + * ## Support, feedback and troubleshooting + * + * Please visit http://support.ably.io/ for access to our knowledgebase and to ask for any assistance. + * + * You can also view the community reported Github issues. + * + * ## Contributing + * + * For guidance on how to contribute to this project, see [CONTRIBUTING.md](CONTRIBUTING.md). + */ terraform {