From 7e70186e1e19f97ac4108b6d72021a7d60f5f5b2 Mon Sep 17 00:00:00 2001 From: Charles Kenney Date: Wed, 4 Mar 2020 15:18:15 -0500 Subject: [PATCH] make docs markdownlint compliant --- .markdownlint.yml | 2 +- website/docs/d/account.html.md | 2 +- website/docs/d/domain.html.md | 2 +- website/docs/d/image.html.md | 2 +- website/docs/d/object_storage_cluster.html.md | 2 +- website/docs/d/profile.html.md | 2 +- website/docs/d/sshkey.html.md | 2 +- website/docs/d/user.html.md | 2 +- website/docs/r/domain_record.html.md | 1 + website/docs/r/nodebalancer.html.md | 2 +- website/docs/r/nodebalancer_config.html.md | 2 +- website/docs/r/object_storage_bucket.html.md | 7 +++---- website/docs/r/sshkey.html.md | 1 - website/docs/r/volume.html.md | 2 +- 14 files changed, 15 insertions(+), 16 deletions(-) diff --git a/.markdownlint.yml b/.markdownlint.yml index ad39f2552..f141ef27b 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -1,8 +1,8 @@ # Configuration for markdownlint # https://github.com/DavidAnson/markdownlint#configuration - default: true # Disabled Rules # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md line-length: false +fenced-code-language: false diff --git a/website/docs/d/account.html.md b/website/docs/d/account.html.md index 2ffe1aa7a..ede8ad2f6 100644 --- a/website/docs/d/account.html.md +++ b/website/docs/d/account.html.md @@ -50,4 +50,4 @@ The Linode Account resource exports the following attributes: * `zip` - The zip code of this Account's billing address. -* `balance` - This Account's balance, in US dollars. \ No newline at end of file +* `balance` - This Account's balance, in US dollars. diff --git a/website/docs/d/domain.html.md b/website/docs/d/domain.html.md index f167529b9..2b6a2eec7 100644 --- a/website/docs/d/domain.html.md +++ b/website/docs/d/domain.html.md @@ -55,7 +55,7 @@ The Linode Domain resource exports the following attributes: * `ttl_sec` - 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * `retry_sec` - The interval, in seconds, at which a failed refresh should be retried. -* + * `expire_sec` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * `refresh_sec` - The amount of time in seconds before this Domain should be refreshed. diff --git a/website/docs/d/image.html.md b/website/docs/d/image.html.md index 325b89993..57eb19906 100644 --- a/website/docs/d/image.html.md +++ b/website/docs/d/image.html.md @@ -46,4 +46,4 @@ The Linode Image resource exports the following attributes: * `type` - How the Image was created. Manual Images can be created at any time. image"Automatic" Images are created automatically from a deleted Linode. -* `vendor` - The upstream distribution vendor. `None` for private Images. +* `vendor` - The upstream distribution vendor. `None` for private Images. diff --git a/website/docs/d/object_storage_cluster.html.md b/website/docs/d/object_storage_cluster.html.md index bc7c2c4d2..838ff5386 100644 --- a/website/docs/d/object_storage_cluster.html.md +++ b/website/docs/d/object_storage_cluster.html.md @@ -24,7 +24,7 @@ data "linode_object_storage_cluster" "primary" { The following arguments are supported: -* `id` - (Required) The unique ID of this cluster. +* `id` - (Required) The unique ID of this cluster. ## Attributes diff --git a/website/docs/d/profile.html.md b/website/docs/d/profile.html.md index cd5303774..2dd673e23 100644 --- a/website/docs/d/profile.html.md +++ b/website/docs/d/profile.html.md @@ -56,4 +56,4 @@ The Linode Profile resource exports the following attributes: * `referrals.0.code` - The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit. -* `referrals.0.url` - The referral URL. \ No newline at end of file +* `referrals.0.url` - The referral URL. diff --git a/website/docs/d/sshkey.html.md b/website/docs/d/sshkey.html.md index 18b50ba65..573d35fa3 100644 --- a/website/docs/d/sshkey.html.md +++ b/website/docs/d/sshkey.html.md @@ -32,4 +32,4 @@ In addition to all arguments above, the following attributes are exported: - `ssh_key` - The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy. -- `created` - The date this key was added. \ No newline at end of file +- `created` - The date this key was added. diff --git a/website/docs/d/user.html.md b/website/docs/d/user.html.md index 6c0851462..3b26d0962 100644 --- a/website/docs/d/user.html.md +++ b/website/docs/d/user.html.md @@ -34,4 +34,4 @@ The Linode User resource exports the following attributes: * `email` - The email address for this User, for account management communications, and may be used for other communications as configured. -* `restricted` - If true, this User must be granted access to perform actions or access entities on this Account. \ No newline at end of file +* `restricted` - If true, this User must be granted access to perform actions or access entities on this Account. diff --git a/website/docs/r/domain_record.html.md b/website/docs/r/domain_record.html.md index e42fb085b..1e4b24535 100644 --- a/website/docs/r/domain_record.html.md +++ b/website/docs/r/domain_record.html.md @@ -41,6 +41,7 @@ The following arguments are supported: * `record_type` - (Required) The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. *Changing `record_type` forces the creation of a new Linode Domain Record.*. * `target` - (Required) The target for this Record. This field's actual usage depends on the type of record this represents. For A and AAAA records, this is the address the named Domain should resolve to. + - - - * `ttl_sec` - (Optional) 'Time to Live' - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value. diff --git a/website/docs/r/nodebalancer.html.md b/website/docs/r/nodebalancer.html.md index 05a83cf58..54aa451a8 100644 --- a/website/docs/r/nodebalancer.html.md +++ b/website/docs/r/nodebalancer.html.md @@ -61,4 +61,4 @@ Linodes NodeBalancers can be imported using the Linode NodeBalancer `id`, e.g. terraform import linode_nodebalancer.mynodebalancer 1234567 ``` -The Linode Guide, [Import Existing Infrastructure to Terraform](https://www.linode.com/docs/applications/configuration-management/import-existing-infrastructure-to-terraform/), offers resource importing examples for NodeBalancers and other Linode resource types. \ No newline at end of file +The Linode Guide, [Import Existing Infrastructure to Terraform](https://www.linode.com/docs/applications/configuration-management/import-existing-infrastructure-to-terraform/), offers resource importing examples for NodeBalancers and other Linode resource types. diff --git a/website/docs/r/nodebalancer_config.html.md b/website/docs/r/nodebalancer_config.html.md index b15453527..6043640b9 100644 --- a/website/docs/r/nodebalancer_config.html.md +++ b/website/docs/r/nodebalancer_config.html.md @@ -94,4 +94,4 @@ NodeBalancer Configs can be imported using the NodeBalancer `nodebalancer_id` fo terraform import linode_nodebalancer_config.http-foobar 1234567,7654321 ``` -The Linode Guide, [Import Existing Infrastructure to Terraform](https://www.linode.com/docs/applications/configuration-management/import-existing-infrastructure-to-terraform/), offers resource importing examples for NodeBalancer Configs and other Linode resource types. \ No newline at end of file +The Linode Guide, [Import Existing Infrastructure to Terraform](https://www.linode.com/docs/applications/configuration-management/import-existing-infrastructure-to-terraform/), offers resource importing examples for NodeBalancer Configs and other Linode resource types. diff --git a/website/docs/r/object_storage_bucket.html.md b/website/docs/r/object_storage_bucket.html.md index 48c7a040b..bbe25763a 100644 --- a/website/docs/r/object_storage_bucket.html.md +++ b/website/docs/r/object_storage_bucket.html.md @@ -16,12 +16,12 @@ The following example shows how one might use this resource to create an Object ```hcl data "linode_object_storage_cluster" "primary" { - id = "us-east-1" + id = "us-east-1" } resource "linode_object_storage_bucket" "foobar" { - cluster = data.linode_object_storage_cluster.primary.id - label = "%s" + cluster = data.linode_object_storage_cluster.primary.id + label = "%s" } ``` @@ -33,4 +33,3 @@ The following arguments are supported: * `cluster` - (Required) The cluster of the Linode Object Storage Bucket. * `label` - (Required) The label of the Linode Object Storage Bucket. - diff --git a/website/docs/r/sshkey.html.md b/website/docs/r/sshkey.html.md index a6bc805c5..dcd083059 100644 --- a/website/docs/r/sshkey.html.md +++ b/website/docs/r/sshkey.html.md @@ -39,7 +39,6 @@ The following arguments are supported: * `ssh_key` - The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy. - ## Attributes This resource exports the following attributes: diff --git a/website/docs/r/volume.html.md b/website/docs/r/volume.html.md index dbf291481..988afa771 100644 --- a/website/docs/r/volume.html.md +++ b/website/docs/r/volume.html.md @@ -91,4 +91,4 @@ Linodes Volumes can be imported using the Linode Volume `id`, e.g. terraform import linode_volume.myvolume 1234567 ``` -The Linode Guide, [Import Existing Infrastructure to Terraform](https://www.linode.com/docs/applications/configuration-management/import-existing-infrastructure-to-terraform/), offers resource importing examples for Block Storage Volumes and other Linode resource types. \ No newline at end of file +The Linode Guide, [Import Existing Infrastructure to Terraform](https://www.linode.com/docs/applications/configuration-management/import-existing-infrastructure-to-terraform/), offers resource importing examples for Block Storage Volumes and other Linode resource types.