From a5098f167c384fedaff1fb7d7b65307add0a32c7 Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Thu, 24 Jul 2014 19:35:40 -0400 Subject: [PATCH] website: document dnsimple --- .../providers/dnsimple/index.html.markdown | 37 +++++++++++++++ .../providers/dnsimple/r/record.html.markdown | 46 +++++++++++++++++++ website/source/layouts/_footer.erb | 1 - website/source/layouts/dnsimple.erb | 26 +++++++++++ website/source/layouts/docs.erb | 4 ++ website/source/stylesheets/_docs.less | 1 + website/source/stylesheets/main.css | 3 ++ 7 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 website/source/docs/providers/dnsimple/index.html.markdown create mode 100644 website/source/docs/providers/dnsimple/r/record.html.markdown create mode 100644 website/source/layouts/dnsimple.erb diff --git a/website/source/docs/providers/dnsimple/index.html.markdown b/website/source/docs/providers/dnsimple/index.html.markdown new file mode 100644 index 000000000..ac84f177d --- /dev/null +++ b/website/source/docs/providers/dnsimple/index.html.markdown @@ -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 + + diff --git a/website/source/docs/providers/dnsimple/r/record.html.markdown b/website/source/docs/providers/dnsimple/r/record.html.markdown new file mode 100644 index 000000000..bf6afae09 --- /dev/null +++ b/website/source/docs/providers/dnsimple/r/record.html.markdown @@ -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 + diff --git a/website/source/layouts/_footer.erb b/website/source/layouts/_footer.erb index 4baa7bccd..75290181d 100644 --- a/website/source/layouts/_footer.erb +++ b/website/source/layouts/_footer.erb @@ -7,7 +7,6 @@
  • Intro
  • Docs
  • Community
    • -
  • Demo
    • diff --git a/website/source/layouts/dnsimple.erb b/website/source/layouts/dnsimple.erb new file mode 100644 index 000000000..6548e3b26 --- /dev/null +++ b/website/source/layouts/dnsimple.erb @@ -0,0 +1,26 @@ +<% wrap_layout :inner do %> + <% content_for :sidebar do %> + + <% end %> + + <%= yield %> + <% end %> diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index cf1989395..1d58f4973 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -82,6 +82,10 @@ > DigitalOcean + + + > + DNSimple > diff --git a/website/source/stylesheets/_docs.less b/website/source/stylesheets/_docs.less index 8a01081aa..ab09b65d5 100755 --- a/website/source/stylesheets/_docs.less +++ b/website/source/stylesheets/_docs.less @@ -6,6 +6,7 @@ body.page-sub{ background-color: @light-black; } +body.layout-dnsimple, body.layout-heroku, body.layout-digitalocean, body.layout-aws, diff --git a/website/source/stylesheets/main.css b/website/source/stylesheets/main.css index cfe51c1aa..defdec6fc 100644 --- a/website/source/stylesheets/main.css +++ b/website/source/stylesheets/main.css @@ -1265,6 +1265,7 @@ body.page-home #footer { body.page-sub { background-color: #242424; } +body.layout-dnsimple, body.layout-heroku, body.layout-digitalocean, body.layout-aws, @@ -1273,6 +1274,7 @@ body.layout-inner, body.layout-intro { 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-digitalocean > .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; 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-digitalocean > .container .col-md-8[role=main] > div, body.layout-aws > .container .col-md-8[role=main] > div,