Skip to content

Commit

Permalink
Update website docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Kahn committed Aug 2, 2018
1 parent 992219a commit 4a7a560
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 78 deletions.
27 changes: 12 additions & 15 deletions website/docs/index.html.markdown
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
---
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.

## 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" {
# ...
}
```
Expand All @@ -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.
24 changes: 12 additions & 12 deletions website/docs/r/alert.html.markdown
Original file line number Diff line number Diff line change
@@ -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"
}
}
```
Expand Down Expand Up @@ -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.
16 changes: 8 additions & 8 deletions website/docs/r/metric.html.markdown
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
20 changes: 10 additions & 10 deletions website/docs/r/service.html.markdown
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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.
Expand Down
18 changes: 9 additions & 9 deletions website/docs/r/space.html.markdown
Original file line number Diff line number Diff line change
@@ -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"
}
```
Expand Down
22 changes: 11 additions & 11 deletions website/docs/r/space_chart.html.markdown
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
26 changes: 13 additions & 13 deletions website/librato.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,27 @@
<a href="/docs/providers/index.html">All Providers</a>
</li>

<li<%= sidebar_current("docs-librato-index") %>>
<a href="/docs/providers/librato/index.html">Librato Provider</a>
<li<%= sidebar_current("docs-appoptics-index") %>>
<a href="/docs/providers/appoptics/index.html">Librato Provider</a>
</li>

<li<%= sidebar_current("docs-librato-resource") %>>
<li<%= sidebar_current("docs-appoptics-resource") %>>
<a href="#">Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-librato-resource-alert") %>>
<a href="/docs/providers/librato/r/alert.html">librato_alert</a>
<li<%= sidebar_current("docs-appoptics-resource-alert") %>>
<a href="/docs/providers/appoptics/r/alert.html">appoptics_alert</a>
</li>
<li<%= sidebar_current("docs-librato-resource-metric") %>>
<a href="/docs/providers/librato/r/metric.html">librato_metric</a>
<li<%= sidebar_current("docs-appoptics-resource-metric") %>>
<a href="/docs/providers/appoptics/r/metric.html">appoptics_metric</a>
</li>
<li<%= sidebar_current("docs-librato-resource-service") %>>
<a href="/docs/providers/librato/r/service.html">librato_service</a>
<li<%= sidebar_current("docs-appoptics-resource-service") %>>
<a href="/docs/providers/appoptics/r/service.html">appoptics_service</a>
</li>
<li<%= sidebar_current("docs-librato-resource-space") %>>
<a href="/docs/providers/librato/r/space.html">librato_space</a>
<li<%= sidebar_current("docs-appoptics-resource-space") %>>
<a href="/docs/providers/appoptics/r/space.html">appoptics_space</a>
</li>
<li<%= sidebar_current("docs-librato-resource-space-chart") %>>
<a href="/docs/providers/librato/r/space_chart.html">librato_space_chart</a>
<li<%= sidebar_current("docs-appoptics-resource-space-chart") %>>
<a href="/docs/providers/appoptics/r/space_chart.html">appoptics_space_chart</a>
</li>
</ul>
</li>
Expand Down

0 comments on commit 4a7a560

Please sign in to comment.