From 4a7a560abeaa6376bd191875f54db21067c61df8 Mon Sep 17 00:00:00 2001 From: Alex Kahn Date: Thu, 2 Aug 2018 12:20:09 -0500 Subject: [PATCH] Update website docs --- website/docs/index.html.markdown | 27 +++++++++++------------- website/docs/r/alert.html.markdown | 24 ++++++++++----------- website/docs/r/metric.html.markdown | 16 +++++++------- website/docs/r/service.html.markdown | 20 +++++++++--------- website/docs/r/space.html.markdown | 18 ++++++++-------- website/docs/r/space_chart.html.markdown | 22 +++++++++---------- website/librato.erb | 26 +++++++++++------------ 7 files changed, 75 insertions(+), 78 deletions(-) diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index b80d830..bc223b4 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown @@ -1,15 +1,15 @@ --- -layout: "librato" -page_title: "Provider: Librato" -sidebar_current: "docs-librato-index" +layout: "appoptics" +page_title: "Provider: AppOptics" +sidebar_current: "docs-appoptics-index" description: |- - The Librato provider is used to interact with the resources supported by Librato. The provider needs to be configured with the proper credentials before it can be used. + The AppOptics provider is used to interact with the resources supported by AppOptics. The provider needs to be configured with the proper credentials before it can be used. --- -# Librato Provider +# AppOptics Provider -The Librato provider is used to interact with the -resources supported by Librato. The provider needs to be configured +The AppOptics provider is used to interact with the +resources supported by AppOptics. The provider needs to be configured with the proper credentials before it can be used. Use the navigation to the left to read about the available resources. @@ -17,14 +17,13 @@ Use the navigation to the left to read about the available resources. ## Example Usage ```hcl -# Configure the Librato provider -provider "librato" { - email = "ops@company.com" +# Configure the AppOptics provider +provider "appoptics" { token = "${var.librato_token}" } # Create a new space -resource "librato_space" "default" { +resource "appoptics_space" "default" { # ... } ``` @@ -33,7 +32,5 @@ resource "librato_space" "default" { The following arguments are supported: -* `token` - (Required) Librato API token. It must be provided, but it can also - be sourced from the `LIBRATO_TOKEN` environment variable. -* `email` - (Required) Librato email address. It must be provided, but it can - also be sourced from the `LIBRATO_EMAIL` environment variable. +* `token` - (Required) AppOptics API token. It must be provided, but it can also + be sourced from the `APPOPTICS_TOKEN` environment variable. diff --git a/website/docs/r/alert.html.markdown b/website/docs/r/alert.html.markdown index 85dc6a7..0ecb328 100644 --- a/website/docs/r/alert.html.markdown +++ b/website/docs/r/alert.html.markdown @@ -1,29 +1,29 @@ --- -layout: "librato" -page_title: "Librato: librato_alert" -sidebar_current: "docs-librato-resource-alert" +layout: "appoptics" +page_title: "AppOptics: appoptics_alert" +sidebar_current: "docs-appoptics-resource-alert" description: |- - Provides a Librato Alert resource. This can be used to create and manage alerts on Librato. + Provides a AppOptics Alert resource. This can be used to create and manage alerts on AppOptics. --- -# librato\_alert +# appoptics\_alert -Provides a Librato Alert resource. This can be used to -create and manage alerts on Librato. +Provides a AppOptics Alert resource. This can be used to +create and manage alerts on AppOptics. ## Example Usage ```hcl -# Create a new Librato alert -resource "librato_alert" "myalert" { +# Create a new AppOptics alert +resource "appoptics_alert" "myalert" { name = "MyAlert" description = "A Test Alert" - services = ["${librato_service.myservice.id}"] + services = ["${appoptics_service.myservice.id}"] condition { type = "above" threshold = 10 - metric_name = "librato.cpu.percent.idle" + metric_name = "appoptics.cpu.percent.idle" } } ``` @@ -64,4 +64,4 @@ Conditions (`condition`) support the following: Attributes (`attributes`) support the following: -* `runbook_url` - a URL for the runbook to be followed when this alert is firing. Used in the Librato UI if set. +* `runbook_url` - a URL for the runbook to be followed when this alert is firing. Used in the AppOptics UI if set. diff --git a/website/docs/r/metric.html.markdown b/website/docs/r/metric.html.markdown index 2f2ba9f..32cba14 100644 --- a/website/docs/r/metric.html.markdown +++ b/website/docs/r/metric.html.markdown @@ -1,20 +1,20 @@ --- -layout: "librato" -page_title: "Librato: librato_metric" -sidebar_current: "docs-librato-resource-metric" +layout: "appoptics" +page_title: "AppOptics: appoptics_metric" +sidebar_current: "docs-appoptics-resource-metric" description: |- - Provides a Librato Metric resource. This can be used to create and manage metrics on Librato. + Provides a AppOptics Metric resource. This can be used to create and manage metrics on AppOptics. --- -# librato\_metric +# appoptics\_metric -Provides a Librato Metric resource. This can be used to create and manage metrics on Librato. +Provides a AppOptics Metric resource. This can be used to create and manage metrics on AppOptics. ## Example Usage ```hcl -# Create a new Librato metric -resource "librato_metric" "mymetric" { +# Create a new AppOptics metric +resource "appoptics_metric" "mymetric" { name = "MyMetric" type = "counter" description = "A Test Metric" diff --git a/website/docs/r/service.html.markdown b/website/docs/r/service.html.markdown index 1e579bf..654a662 100644 --- a/website/docs/r/service.html.markdown +++ b/website/docs/r/service.html.markdown @@ -1,21 +1,21 @@ --- -layout: "librato" -page_title: "Librato: librato_service" -sidebar_current: "docs-librato-resource-service" +layout: "appoptics" +page_title: "AppOptics: appoptics_service" +sidebar_current: "docs-appoptics-resource-service" description: |- - Provides a Librato service resource. This can be used to create and manage notification services on Librato. + Provides a AppOptics service resource. This can be used to create and manage notification services on AppOptics. --- -# librato\_service +# appoptics\_service -Provides a Librato Service resource. This can be used to -create and manage notification services on Librato. +Provides a AppOptics Service resource. This can be used to +create and manage notification services on AppOptics. ## Example Usage ```hcl -# Create a new Librato service -resource "librato_service" "email" { +# Create a new AppOptics service +resource "appoptics_service" "email" { title = "Email the admins" type = "mail" @@ -29,7 +29,7 @@ EOF ## Argument Reference -The following arguments are supported. Please check the [relevant documentation](https://github.com/librato/librato-services/tree/master/services) for each type of alert. +The following arguments are supported. Please check the [relevant documentation](https://github.com/appoptics/appoptics-services/tree/master/services) for each type of alert. * `type` - (Required) The type of notificaion. * `title` - (Required) The alert title. diff --git a/website/docs/r/space.html.markdown b/website/docs/r/space.html.markdown index 1d6670d..c9d53f7 100644 --- a/website/docs/r/space.html.markdown +++ b/website/docs/r/space.html.markdown @@ -1,21 +1,21 @@ --- -layout: "librato" -page_title: "Librato: librato_space" -sidebar_current: "docs-librato-resource-space" +layout: "appoptics" +page_title: "AppOptics: appoptics_space" +sidebar_current: "docs-appoptics-resource-space" description: |- - Provides a Librato Space resource. This can be used to create and manage spaces on Librato. + Provides a AppOptics Space resource. This can be used to create and manage spaces on AppOptics. --- -# librato\_space +# appoptics\_space -Provides a Librato Space resource. This can be used to -create and manage spaces on Librato. +Provides a AppOptics Space resource. This can be used to +create and manage spaces on AppOptics. ## Example Usage ```hcl -# Create a new Librato space -resource "librato_space" "default" { +# Create a new AppOptics space +resource "appoptics_space" "default" { name = "My New Space" } ``` diff --git a/website/docs/r/space_chart.html.markdown b/website/docs/r/space_chart.html.markdown index 90ad758..9037cb0 100644 --- a/website/docs/r/space_chart.html.markdown +++ b/website/docs/r/space_chart.html.markdown @@ -1,28 +1,28 @@ --- -layout: "librato" -page_title: "Librato: librato_space_chart" -sidebar_current: "docs-librato-resource-space-chart" +layout: "appoptics" +page_title: "AppOptics: appoptics_space_chart" +sidebar_current: "docs-appoptics-resource-space-chart" description: |- - Provides a Librato Space Chart resource. This can be used to create and manage charts in Librato Spaces. + Provides a AppOptics Space Chart resource. This can be used to create and manage charts in AppOptics Spaces. --- -# librato\_space\_chart +# appoptics\_space\_chart -Provides a Librato Space Chart resource. This can be used to -create and manage charts in Librato Spaces. +Provides a AppOptics Space Chart resource. This can be used to +create and manage charts in AppOptics Spaces. ## Example Usage ```hcl -# Create a new Librato space -resource "librato_space" "my_space" { +# Create a new AppOptics space +resource "appoptics_space" "my_space" { name = "My New Space" } # Create a new chart -resource "librato_space_chart" "server_temperature" { +resource "appoptics_space_chart" "server_temperature" { name = "Server Temperature" - space_id = "${librato_space.my_space.id}" + space_id = "${appoptics_space.my_space.id}" stream { metric = "server_temp" diff --git a/website/librato.erb b/website/librato.erb index 88cc447..fcb3fd2 100644 --- a/website/librato.erb +++ b/website/librato.erb @@ -6,27 +6,27 @@ All Providers - > - Librato Provider + > + Librato Provider - > + > Resources