From 3dcbdf0e284a833f96614f9c7318624045ff51f8 Mon Sep 17 00:00:00 2001 From: clint shryock Date: Thu, 24 Mar 2016 09:53:25 -0500 Subject: [PATCH] provider/fastly: Documentation updates --- .../docs/providers/fastly/index.html.markdown | 13 ++++++++++--- .../providers/fastly/r/service_v1.html.markdown | 12 ++++++------ 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/website/source/docs/providers/fastly/index.html.markdown b/website/source/docs/providers/fastly/index.html.markdown index fc80da846..c2a8baf4e 100644 --- a/website/source/docs/providers/fastly/index.html.markdown +++ b/website/source/docs/providers/fastly/index.html.markdown @@ -44,7 +44,7 @@ explained below: ### Static API Key ### Static credentials can be provided by adding a `api_key` in-line in the -fastly provider block: +Fastly provider block: Usage: @@ -52,6 +52,10 @@ Usage: provider "fastly" { api_key = "test" } + +resource "fastly_service_v1" "myservice" { + ... +} ``` The API key for an account can be found on the Account page: https://app.fastly.com/#account @@ -59,10 +63,13 @@ The API key for an account can be found on the Account page: https://app.fastly. ###Environment variables You can provide your API key via `FASTLY_API_KEY` environment variable, -representing your Fastly API key. +representing your Fastly API key. When using this method, you may omit the +Fastly `provider` block entirely: ``` -provider "fastly" {} +resource "fastly_service_v1" "myservice" { + ... +} ``` Usage: diff --git a/website/source/docs/providers/fastly/r/service_v1.html.markdown b/website/source/docs/providers/fastly/r/service_v1.html.markdown index 8ded8d7fc..8e84234f0 100644 --- a/website/source/docs/providers/fastly/r/service_v1.html.markdown +++ b/website/source/docs/providers/fastly/r/service_v1.html.markdown @@ -8,12 +8,12 @@ description: |- # fastly\_service\_v1 -Provides an Fastly Service, representing the configuration for a website, app, +Provides a Fastly Service, representing the configuration for a website, app, api, or anything else to be served through Fastly. A Service encompasses Domains and Backends. -The Service resource requires a domain name that is correctly setup to direct -traffic to the Fastly service. See Fastly's guide on [Adding CNAME Records][2] +The Service resource requires a domain name that is correctly set up to direct +traffic to the Fastly service. See Fastly's guide on [Adding CNAME Records][fastly-cname] on their documentation site for guidance. ## Example Usage @@ -76,7 +76,7 @@ resource "aws_s3_bucket" "website" { **Note:** For an AWS S3 Bucket, the Backend address is `.s3-website-.amazonaws.com`. The `default_host` attribute should be set to `.s3-website-.amazonaws.com`. See the -Fastly documentation on [Amazon S3][1] +Fastly documentation on [Amazon S3][fastly-s3] ## Argument Reference @@ -131,6 +131,6 @@ The following attributes are exported: * `force_destroy` - Force the destruction of the Service on delete -[1]: https://docs.fastly.com/guides/integrations/amazon-s3 -[2]: https://docs.fastly.com/guides/basic-setup/adding-cname-records +[fastly-s3]: https://docs.fastly.com/guides/integrations/amazon-s3 +[fastly-cname]: https://docs.fastly.com/guides/basic-setup/adding-cname-records