Updates README and docs

[dm36]

Makes updates to the README and docs such as pluralizing category. Additionally makes code changes to comply with the categories update

Ref: LOG-7687 Semver: Patch

[dm36]

@nimbinatus reformatted the Terraform docs to italicize optional and required, default be consistently at the end and to give type info.

@michaelshi-logdna updated 30s -> 30 for triggerintervals.

@tanberry Have added the pre-requirements and considerations as well as the updates to the README.

please have another look :) thank you!

[mdeltito]

can we add the coveralls badge to the README since you already set it up? 🎉

[dm36]

@tanberry was referencing this section here at the bottom of https://github.com/logdna/terraform-provider-logdna/blob/78dc74c123bb812a783d2457bd8cb7e161fd8a19/docs/index.md:

Argument Reference

The following arguments are supported:

• servicekey: (Required) LogDNA Account Service Key. This can be generated or retrieved from Settings > Organization > API Keys
• url: (Optional) Default: api.logdna.com The LogDNA region URL. If you’re configuring an IBM Log Analysis with LogDNA or IBM Cloud Activity Tracker with LogDNA you’ll need to ensure url is set to the right endpoint depending on the IBM region

[alfeng6]

A few comments/feedback on the TF readme.io docs: — I’m waiting for a sync to complete to make sure our examples work.

• “One use case for the Terraform provider is if you need to quickly spin up multiple Alerts in several Kubernetes clusters and you need them to all be exactly the same, then use Terraform to create and deploy the alerts.” this is a bit hard to read — maybe break down into two sentences?
• “Verify that Terraform is installed.” — Can you link to Terraform installation docs? and tell the user how to verify their version number? (https://learn.hashicorp.com/tutorials/terraform/install-cli)
• “Have the service key for your Organization available” — You can link to it directly: https://app.logdna.com/manage/api-keys
• “Be aware that the underlying LogDNA Configuration API has a rate limit of 50 requests per minute, therefore when using the LogDNA provider in Terraform there is a limit 50 resource update operations a minute” — Does this mean that I can only create 50 requests a minute or will my total requests buffer to be acted on at a rate of 50 requests/min? Also for bullets, will we add a period at the end of all of them?
• “If you do not provide a specific…” do we want to include the IBM Cloud part?
• The example code gives the version 1.0.0 but that hasn’t been released yet so we should put in 0.0.1 we should add the terraform init, terraform plan and terraform apply commands to teach users who are not familiar with TF

[michaelshi-logdna]

The example code gives the version 1.0.0 but that hasn’t been released yet so we should put in 0.0.1 we should add the terraform init, terraform plan and terraform apply commands to teach users who are not familiar with TF

fwiw the intent is that we will launch with a 1.0.0 so having examples prepped for that helps make sure we don't accidentally sneak in a 0.0.1 outdated reference on launch