website: document dnsimple

This commit is contained in:
Armon Dadgar 2014-07-24 19:35:40 -04:00
parent decc837fa3
commit a5098f167c
7 changed files with 117 additions and 1 deletions

View File

@ -0,0 +1,37 @@
---
layout: "dnsimple"
page_title: "Provider: DNSimple"
sidebar_current: "docs-dnsimple-index"
---
# DNSimple Provider
The DNSimple provider is used to interact with the
resources supported by DNSimple. 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
```
# Configure the DNSimple provider
provider "dnsimple" {
token = "${var.dnsimple_token}"
email = "${var.dnsimple_email}"
}
# Create a record
resource "dnsimple_record" "www" {
...
}
```
## Argument Reference
The following arguments are supported:
* `token` - (Required) The DNSimple API token
* `email` - (Required) The email associated with the token

View File

@ -0,0 +1,46 @@
---
layout: "dnsimple"
page_title: "DNSimple: dnsimple_record"
sidebar_current: "docs-dnsimple-resource-record"
---
# dnsimple\_record
Provides a DNSimple record resource.
## Example Usage
```
# Add a record to the domain
resource "dnsimple_record" "foobar" {
domain = "${var.dnsimple_domain}"
name = "terraform"
value = "192.168.0.11"
type = "A"
ttl = 3600
}
```
## Argument Reference
The following arguments are supported:
* `domain` - (Required) The domain to add the record to
* `name` - (Required) The name of the record
* `value` - (Required) The value of the record
* `type` - (Required) The type of the record
* `ttl` - (Optional) The TTL of the record
## Attributes Reference
The following attributes are exported:
* `id` - The record ID
* `name` - The name of the record
* `value` - The value of the record
* `type` - The type of the record
* `ttl` - The ttl of the record
* `priority` - The priority of the record
* `domain_id` - The domain ID of the record
* `hostname` - The FQDN of the record

View File

@ -7,7 +7,6 @@
<li class="li-under"><a href="/intro/index.html">Intro</a></li> <li class="li-under"><a href="/intro/index.html">Intro</a></li>
<li class="active li-under"><a href="/docs/index.html">Docs</a></li> <li class="active li-under"><a href="/docs/index.html">Docs</a></li>
<li class="li-under"><a href="/community.html">Community</a></li> <li class="li-under"><a href="/community.html">Community</a></li>
<li class="li-under"><a href="http://demo.terraform.io/">Demo</a></li>
</ul> </ul>
</div> </div>
<div class="footer-hashi col-sm-5 col-xs-12"> <div class="footer-hashi col-sm-5 col-xs-12">

View File

@ -0,0 +1,26 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<div class="docs-sidebar hidden-print affix-top" role="complementary">
<ul class="nav docs-sidenav">
<li<%= sidebar_current("docs-home") %>>
<a href="/docs/index.html">&laquo; Documentation Home</a>
</li>
<li<%= sidebar_current("docs-dnsimple-index") %>>
<a href="/docs/providers/dnsimple/index.html">DNSimple Provider</a>
</li>
<li<%= sidebar_current("docs-dnsimple-resource") %>>
<a href="#">Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-dnsimple-resource-record") %>>
<a href="/docs/providers/dnsimple/r/record.html">dnsimple_record</a>
</li>
</ul>
</li>
</ul>
</div>
<% end %>
<%= yield %>
<% end %>

View File

@ -84,6 +84,10 @@
<a href="/docs/providers/do/index.html">DigitalOcean</a> <a href="/docs/providers/do/index.html">DigitalOcean</a>
</li> </li>
<li<%= sidebar_current("docs-providers-dnsimple") %>>
<a href="/docs/providers/dnsimple/index.html">DNSimple</a>
</li>
<li<%= sidebar_current("docs-providers-heroku") %>> <li<%= sidebar_current("docs-providers-heroku") %>>
<a href="/docs/providers/heroku/index.html">Heroku</a> <a href="/docs/providers/heroku/index.html">Heroku</a>
</li> </li>

View File

@ -6,6 +6,7 @@ body.page-sub{
background-color: @light-black; background-color: @light-black;
} }
body.layout-dnsimple,
body.layout-heroku, body.layout-heroku,
body.layout-digitalocean, body.layout-digitalocean,
body.layout-aws, body.layout-aws,

View File

@ -1265,6 +1265,7 @@ body.page-home #footer {
body.page-sub { body.page-sub {
background-color: #242424; background-color: #242424;
} }
body.layout-dnsimple,
body.layout-heroku, body.layout-heroku,
body.layout-digitalocean, body.layout-digitalocean,
body.layout-aws, body.layout-aws,
@ -1273,6 +1274,7 @@ body.layout-inner,
body.layout-intro { body.layout-intro {
background: #242424 url('../images/sidebar-wire.png') left 62px no-repeat; background: #242424 url('../images/sidebar-wire.png') left 62px no-repeat;
} }
body.layout-dnsimple > .container .col-md-8[role=main],
body.layout-heroku > .container .col-md-8[role=main], body.layout-heroku > .container .col-md-8[role=main],
body.layout-digitalocean > .container .col-md-8[role=main], body.layout-digitalocean > .container .col-md-8[role=main],
body.layout-aws > .container .col-md-8[role=main], body.layout-aws > .container .col-md-8[role=main],
@ -1282,6 +1284,7 @@ body.layout-intro > .container .col-md-8[role=main] {
min-height: 800px; min-height: 800px;
background-color: white; background-color: white;
} }
body.layout-dnsimple > .container .col-md-8[role=main] > div,
body.layout-heroku > .container .col-md-8[role=main] > div, body.layout-heroku > .container .col-md-8[role=main] > div,
body.layout-digitalocean > .container .col-md-8[role=main] > div, body.layout-digitalocean > .container .col-md-8[role=main] > div,
body.layout-aws > .container .col-md-8[role=main] > div, body.layout-aws > .container .col-md-8[role=main] > div,