Skip to content

Commit a5098f1

Browse files
committed
website: document dnsimple
1 parent decc837 commit a5098f1

7 files changed

Lines changed: 117 additions & 1 deletion

File tree

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: "dnsimple"
3+
page_title: "Provider: DNSimple"
4+
sidebar_current: "docs-dnsimple-index"
5+
---
6+
7+
# DNSimple Provider
8+
9+
The DNSimple provider is used to interact with the
10+
resources supported by DNSimple. The provider needs to be configured
11+
with the proper credentials before it can be used.
12+
13+
Use the navigation to the left to read about the available resources.
14+
15+
## Example Usage
16+
17+
```
18+
# Configure the DNSimple provider
19+
provider "dnsimple" {
20+
token = "${var.dnsimple_token}"
21+
email = "${var.dnsimple_email}"
22+
}
23+
24+
# Create a record
25+
resource "dnsimple_record" "www" {
26+
...
27+
}
28+
```
29+
30+
## Argument Reference
31+
32+
The following arguments are supported:
33+
34+
* `token` - (Required) The DNSimple API token
35+
* `email` - (Required) The email associated with the token
36+
37+
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: "dnsimple"
3+
page_title: "DNSimple: dnsimple_record"
4+
sidebar_current: "docs-dnsimple-resource-record"
5+
---
6+
7+
# dnsimple\_record
8+
9+
Provides a DNSimple record resource.
10+
11+
## Example Usage
12+
13+
```
14+
# Add a record to the domain
15+
resource "dnsimple_record" "foobar" {
16+
domain = "${var.dnsimple_domain}"
17+
name = "terraform"
18+
value = "192.168.0.11"
19+
type = "A"
20+
ttl = 3600
21+
}
22+
```
23+
24+
## Argument Reference
25+
26+
The following arguments are supported:
27+
28+
* `domain` - (Required) The domain to add the record to
29+
* `name` - (Required) The name of the record
30+
* `value` - (Required) The value of the record
31+
* `type` - (Required) The type of the record
32+
* `ttl` - (Optional) The TTL of the record
33+
34+
## Attributes Reference
35+
36+
The following attributes are exported:
37+
38+
* `id` - The record ID
39+
* `name` - The name of the record
40+
* `value` - The value of the record
41+
* `type` - The type of the record
42+
* `ttl` - The ttl of the record
43+
* `priority` - The priority of the record
44+
* `domain_id` - The domain ID of the record
45+
* `hostname` - The FQDN of the record
46+

website/source/layouts/_footer.erb

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
<li class="li-under"><a href="/intro/index.html">Intro</a></li>
88
<li class="active li-under"><a href="/docs/index.html">Docs</a></li>
99
<li class="li-under"><a href="/community.html">Community</a></li>
10-
<li class="li-under"><a href="http://demo.terraform.io/">Demo</a></li>
1110
</ul>
1211
</div>
1312
<div class="footer-hashi col-sm-5 col-xs-12">
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<% wrap_layout :inner do %>
2+
<% content_for :sidebar do %>
3+
<div class="docs-sidebar hidden-print affix-top" role="complementary">
4+
<ul class="nav docs-sidenav">
5+
<li<%= sidebar_current("docs-home") %>>
6+
<a href="/docs/index.html">&laquo; Documentation Home</a>
7+
</li>
8+
9+
<li<%= sidebar_current("docs-dnsimple-index") %>>
10+
<a href="/docs/providers/dnsimple/index.html">DNSimple Provider</a>
11+
</li>
12+
13+
<li<%= sidebar_current("docs-dnsimple-resource") %>>
14+
<a href="#">Resources</a>
15+
<ul class="nav nav-visible">
16+
<li<%= sidebar_current("docs-dnsimple-resource-record") %>>
17+
<a href="/docs/providers/dnsimple/r/record.html">dnsimple_record</a>
18+
</li>
19+
</ul>
20+
</li>
21+
</ul>
22+
</div>
23+
<% end %>
24+
25+
<%= yield %>
26+
<% end %>

website/source/layouts/docs.erb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@
8282

8383
<li<%= sidebar_current("docs-providers-do") %>>
8484
<a href="/docs/providers/do/index.html">DigitalOcean</a>
85+
</li>
86+
87+
<li<%= sidebar_current("docs-providers-dnsimple") %>>
88+
<a href="/docs/providers/dnsimple/index.html">DNSimple</a>
8589
</li>
8690

8791
<li<%= sidebar_current("docs-providers-heroku") %>>

website/source/stylesheets/_docs.less

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ body.page-sub{
66
background-color: @light-black;
77
}
88

9+
body.layout-dnsimple,
910
body.layout-heroku,
1011
body.layout-digitalocean,
1112
body.layout-aws,

website/source/stylesheets/main.css

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,6 +1265,7 @@ body.page-home #footer {
12651265
body.page-sub {
12661266
background-color: #242424;
12671267
}
1268+
body.layout-dnsimple,
12681269
body.layout-heroku,
12691270
body.layout-digitalocean,
12701271
body.layout-aws,
@@ -1273,6 +1274,7 @@ body.layout-inner,
12731274
body.layout-intro {
12741275
background: #242424 url('../images/sidebar-wire.png') left 62px no-repeat;
12751276
}
1277+
body.layout-dnsimple > .container .col-md-8[role=main],
12761278
body.layout-heroku > .container .col-md-8[role=main],
12771279
body.layout-digitalocean > .container .col-md-8[role=main],
12781280
body.layout-aws > .container .col-md-8[role=main],
@@ -1282,6 +1284,7 @@ body.layout-intro > .container .col-md-8[role=main] {
12821284
min-height: 800px;
12831285
background-color: white;
12841286
}
1287+
body.layout-dnsimple > .container .col-md-8[role=main] > div,
12851288
body.layout-heroku > .container .col-md-8[role=main] > div,
12861289
body.layout-digitalocean > .container .col-md-8[role=main] > div,
12871290
body.layout-aws > .container .col-md-8[role=main] > div,

0 commit comments

Comments
 (0)