Skip to content

Commit

Permalink
docs: Use default terraform-plugin-docs templates for data sources an…
Browse files Browse the repository at this point in the history
…d resources (hashicorp#288)

Reference: hashicorp#285
  • Loading branch information
bflad authored Apr 18, 2023
1 parent 246dc8a commit 781212e
Show file tree
Hide file tree
Showing 56 changed files with 65 additions and 339 deletions.
5 changes: 4 additions & 1 deletion docs/data-sources/a_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_a_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -31,4 +32,6 @@ output "google_addrs" {
### Read-Only

- `addrs` (List of String) A list of IP addresses. IP addresses are always sorted to avoid constant changing plans.
- `id` (String) Always set to the host.
- `id` (String) Always set to the host.


3 changes: 3 additions & 0 deletions docs/data-sources/aaaa_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_aaaa_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -32,3 +33,5 @@ output "google_addrs" {

- `addrs` (List of String) A list of IP addresses. IP addresses are always sorted to avoid constant changing plans.
- `id` (String) Always set to the host.


3 changes: 3 additions & 0 deletions docs/data-sources/cname_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_cname_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -32,3 +33,5 @@ output "hashi_cname" {

- `cname` (String) A CNAME record associated with host.
- `id` (String) Always set to the host.


3 changes: 3 additions & 0 deletions docs/data-sources/mx_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_mx_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -40,3 +41,5 @@ Read-Only:

- `exchange` (String)
- `preference` (Number)


3 changes: 3 additions & 0 deletions docs/data-sources/ns_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_ns_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -32,3 +33,5 @@ output "google_nameservers" {

- `id` (String) Always set to the domain.
- `nameservers` (List of String) A list of nameservers. Nameservers are always sorted to avoid constant changing plans.


3 changes: 2 additions & 1 deletion docs/data-sources/ptr_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_ptr_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -33,4 +34,4 @@ output "hashi_ptr" {
- `id` (String) Always set to the IP address.
- `ptr` (String) A PTR record associated with `ip_address`.

__NOTE__: Only the first result is taken from the query.

3 changes: 3 additions & 0 deletions docs/data-sources/srv_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_srv_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -42,3 +43,5 @@ Read-Only:
- `priority` (Number)
- `target` (String)
- `weight` (Number)


3 changes: 3 additions & 0 deletions docs/data-sources/txt_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_txt_record_set Data Source - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -37,3 +38,5 @@ output "hashi_txts" {
- `id` (String) Always set to the host.
- `record` (String) The first TXT record.
- `records` (List of String) A list of TXT records.


4 changes: 3 additions & 1 deletion docs/resources/a_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_a_record_set Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -43,8 +44,9 @@ resource "dns_a_record_set" "www" {

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
# Import using the FQDN.
terraform import dns_a_record_set.www www.example.com.
```
4 changes: 3 additions & 1 deletion docs/resources/aaaa_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_aaaa_record_set Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -42,8 +43,9 @@ resource "dns_aaaa_record_set" "www" {

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
# Import using the FQDN.
terraform import dns_aaaa_record_set.www www.example.com.
```
4 changes: 3 additions & 1 deletion docs/resources/cname_record.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_cname_record Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -39,8 +40,9 @@ resource "dns_cname_record" "foo" {

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
# Import using the FQDN.
terraform import dns_cname_record.foo foo.example.com.
```
4 changes: 3 additions & 1 deletion docs/resources/mx_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_mx_record_set Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -80,8 +81,9 @@ Required:

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
# Import using the FQDN.
terraform import dns_mx_record_set.mx example.com.
```
5 changes: 3 additions & 2 deletions docs/resources/ns_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_ns_record_set Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -42,9 +43,9 @@ resource "dns_ns_record_set" "www" {

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
# Import using the FQDN.
terraform import dns_ns_record_set.www www.example.com.
```

5 changes: 3 additions & 2 deletions docs/resources/ptr_record.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_ptr_record Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -39,9 +40,9 @@ resource "dns_ptr_record" "dns-sd" {

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
# Import using the FQDN.
terraform import dns_ptr_record.dns-sd r._dns-sd.example.com.
```

5 changes: 3 additions & 2 deletions docs/resources/srv_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_srv_record_set Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -66,9 +67,9 @@ Required:

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
# Import using the FQDN.
terraform import dns_srv_record_set.sip _sip._tcp.example.com.
```

6 changes: 4 additions & 2 deletions docs/resources/txt_record_set.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dns_txt_record_set Resource - terraform-provider-dns"
subcategory: ""
description: |-
Expand Down Expand Up @@ -40,8 +41,9 @@ resource "dns_txt_record_set" "google" {

## Import

Records can be imported using the FQDN, e.g.
Import is supported using the following syntax:

```shell
terraform import dns_txt_record_set.google example.com.
# Import using the FQDN.
terraform import dns_txt_record_set.example example.com.
```
2 changes: 2 additions & 0 deletions examples/resources/dns_a_record_set/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_a_record_set.www www.example.com.
File renamed without changes.
2 changes: 2 additions & 0 deletions examples/resources/dns_aaaa_record_set/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_aaaa_record_set.www www.example.com.
2 changes: 2 additions & 0 deletions examples/resources/dns_cname_record/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_cname_record.foo foo.example.com.
2 changes: 2 additions & 0 deletions examples/resources/dns_mx_record_set/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_mx_record_set.mx example.com.
2 changes: 2 additions & 0 deletions examples/resources/dns_ns_record_set/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_ns_record_set.www www.example.com.
2 changes: 2 additions & 0 deletions examples/resources/dns_ptr_record/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_ptr_record.dns-sd r._dns-sd.example.com.
2 changes: 2 additions & 0 deletions examples/resources/dns_srv_record_set/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_srv_record_set.sip _sip._tcp.example.com.
2 changes: 2 additions & 0 deletions examples/resources/dns_txt_record_set/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Import using the FQDN.
terraform import dns_txt_record_set.example example.com.
16 changes: 0 additions & 16 deletions templates/data-sources/a_record_set.md.tmpl

This file was deleted.

16 changes: 0 additions & 16 deletions templates/data-sources/aaaa_record_set.md.tmpl

This file was deleted.

16 changes: 0 additions & 16 deletions templates/data-sources/cname_record_set.md.tmpl

This file was deleted.

16 changes: 0 additions & 16 deletions templates/data-sources/mx_record_set.md.tmpl

This file was deleted.

16 changes: 0 additions & 16 deletions templates/data-sources/ns_record_set.md.tmpl

This file was deleted.

18 changes: 0 additions & 18 deletions templates/data-sources/ptr_record_set.md.tmpl

This file was deleted.

16 changes: 0 additions & 16 deletions templates/data-sources/srv_record_set.md.tmpl

This file was deleted.

Loading

0 comments on commit 781212e

Please sign in to comment.