More docs cleanup, render provider schema

paultyng · Jul 14, 2020 · 1ed2575 · 1ed2575
1 parent 1e1c450
commit 1ed2575
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 22 deletions.
diff --git a/docs/data-sources/radius_profile.md b/docs/data-sources/radius_profile.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_radius_profile Data Source - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_radius_profile data source can be used to retrieve the ID for a RADIUS profile by name.
 ---

diff --git a/docs/data-sources/user_group.md b/docs/data-sources/user_group.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_user_group Data Source - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_user_group data source can be used to retrieve the ID for a user group by name.
 ---

diff --git a/docs/data-sources/wlan_group.md b/docs/data-sources/wlan_group.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_wlan_group Data Source - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_wlan_group data source can be used to retrieve the ID for a WLAN group by name.
 ---

diff --git a/docs/index.md b/docs/index.md
@@ -21,3 +21,13 @@ provider "unifi" {
  # site = "foo" or optionally use UNIFI_SITE env var
 }
 ```
+
+## Schema
+
+### Optional
+
+- **allow_insecure** (Boolean, Optional) Skip verification of TLS certificates of API requests. You may need to set this to `true` if you are using your local API without setting up a signed certificate. Can be specified with the `UNIFI_INSECURE` environment variable.
+- **api_url** (String, Optional) URL of the controller API. Can be specified with the `UNIFI_API` environment variable.
+- **password** (String, Optional) Password for the user accessing the API. Can be specified with the `UNIFI_PASSWORD` environment variable.
+- **site** (String, Optional) The site in the Unifi controller this provider will manage. Can be specified with the `UNIFI_SITE` environment variable. Default: `default`
+- **username** (String, Optional) Local user name for the Unifi controller API. Can be specified with the `UNIFI_USERNAME` environment variable.
diff --git a/docs/resources/firewall_group.md b/docs/resources/firewall_group.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_firewall_group Resource - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_firewall_group manages groups of addresses or ports for use in firewall rules (unifi_firewall_rule).
 ---

diff --git a/docs/resources/firewall_rule.md b/docs/resources/firewall_rule.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_firewall_rule Resource - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_firewall_rule manages an individual firewall rule on the gateway.
 ---

diff --git a/docs/resources/network.md b/docs/resources/network.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_network Resource - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_network manages LAN/VLAN networks.
 ---

diff --git a/docs/resources/port_forward.md b/docs/resources/port_forward.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_port_forward Resource - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_port_forward manages a port forwarding rule on the gateway.
 ---

diff --git a/docs/resources/user.md b/docs/resources/user.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_user Resource - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_user manages a user (or "client" in the UI) of the network, these are identified by unique MAC addresses.
  Users are created in the controller when observed on the network, so the resource defaults to allowing itself to just take over management of a MAC address, but this can be turned off.

diff --git a/docs/resources/user_group.md b/docs/resources/user_group.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_user_group Resource - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_user_group manages a user group (called "client group" in the UI), which can be used to limit bandwidth for groups of users.
 ---

diff --git a/docs/resources/wlan.md b/docs/resources/wlan.md
@@ -1,7 +1,6 @@
 ---
-subcategory: ""
-layout: ""
 page_title: "unifi_wlan Resource - terraform-provider-unifi"
+subcategory: ""
 description: |-
  unifi_wlan manages a WiFi network / SSID.
 ---
@@ -49,10 +48,10 @@ resource "unifi_wlan" "wifi" {
 - **multicast_enhance** (Boolean, Optional) Indicates whether or not Multicast Enhance is turned of for the network.
 - **passphrase** (String, Optional) The passphrase for the network, this is only required if `security` is not set to `open`.
 - **radius_profile_id** (String, Optional) ID of the RADIUS profile to use when security `wpaeap`. You can query this via the `unifi_radius_profile` data source.
-- **schedule** (Block List) Start and stop schedules for the WLAN (see [below for nested schema](#nestedschema--schedule))
+- **schedule** (Block List) Start and stop schedules for the WLAN (see [below for nested schema](#nestedblock--schedule))
 - **vlan_id** (Number, Optional) VLAN ID for the network. Defaults to `1`.
 
-<a id="nestedschema--schedule"></a>
+<a id="nestedblock--schedule"></a>
 ### Nested Schema for `schedule`
 
 Required:

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -12,3 +12,5 @@ The Unifi provider provides resources to interact with a Unifi controller API.
 ## Example Usage
 
 {{tffile "examples/provider/provider.tf"}}
+
+{{ .SchemaMarkdown | trimspace }}