Docs updates, more examples, some tool updates

Change docs dirs based on registry expectations

examples/resources/unifi_firewall_group/resource.tf

@@ -0,0 +1,10 @@
+variable "laptop_ips" {
+  type = list(string)
+}
+
+resource "unifi_firewall_group" "can_print" {
+  name = "can-print"
+  type = "address-group"
+
+  members = var.laptop_ips
+}

examples/resources/unifi_firewall_rule/resource.tf

@@ -0,0 +1,15 @@
+variable "ip_address" {
+  type = string
+}
+
+resource "unifi_firewall_rule" "drop_all" {
+  name    = "drop all"
+  action  = "drop"
+  ruleset = "LAN_IN"
+
+  rule_index = 2011
+
+  protocol = "all"
+
+  dst_address = var.ip_address
+}

internal/provider/data_radius_profile.go

@@ -9,9 +9,7 @@ import (
 
 func dataRADIUSProfile() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_radius_profile data source can be used to retrieve the ID for a RADIUS profile by name.
-`,
+		Description: "`unifi_radius_profile` data source can be used to retrieve the ID for a RADIUS profile by name.",
 
 		Read: dataRADIUSProfileRead,
 

internal/provider/data_user_group.go

@@ -9,9 +9,7 @@ import (
 
 func dataUserGroup() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_user_group data source can be used to retrieve the ID for a user group by name.
-`,
+		Description: "`unifi_user_group` data source can be used to retrieve the ID for a user group by name.",
 
 		Read: dataUserGroupRead,
 

internal/provider/data_wlan_group.go

@@ -9,9 +9,7 @@ import (
 
 func dataWLANGroup() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_wlan_group data source can be used to retrieve the ID for a WLAN group by name.
-`,
+		Description: "`unifi_wlan_group` data source can be used to retrieve the ID for a WLAN group by name.",
 
 		Read: dataWLANGroupRead,
 

internal/provider/resource_firewall_group.go

@@ -10,9 +10,8 @@ import (
 
 func resourceFirewallGroup() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_firewall_group manages groups of addresses or ports for use in firewall rules (unifi_firewall_rule).
-`,
+		Description: "`unifi_firewall_group` manages groups of addresses or ports for use in firewall rules (`unifi_firewall_rule`).",
+
 		Create: resourceFirewallGroupCreate,
 		Read:   resourceFirewallGroupRead,
 		Update: resourceFirewallGroupUpdate,

internal/provider/resource_firewall_rule.go

@@ -13,9 +13,8 @@ var firewallRuleProtocolRegexp = regexp.MustCompile("^$|all|([0-9]|[1-9][0-9]|1[
 
 func resourceFirewallRule() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_firewall_rule manages an individual firewall rule on the gateway.
-`,
+		Description: "`unifi_firewall_rule` manages an individual firewall rule on the gateway.",
+
 		Create: resourceFirewallRuleCreate,
 		Read:   resourceFirewallRuleRead,
 		Update: resourceFirewallRuleUpdate,

internal/provider/resource_network.go

@@ -11,9 +11,7 @@ import (
 
 func resourceNetwork() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_network manages LAN/VLAN networks.
-`,
+		Description: "`unifi_network` manages LAN/VLAN networks.",
 
 		Create: resourceNetworkCreate,
 		Read:   resourceNetworkRead,

internal/provider/resource_port_forward.go

@@ -10,9 +10,7 @@ import (
 
 func resourcePortForward() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_port_forward manages a port forwarding rule on the gateway.
-`,
+		Description: "`unifi_port_forward` manages a port forwarding rule on the gateway.",
 
 		Create: resourcePortForwardCreate,
 		Read:   resourcePortForwardRead,

internal/provider/resource_user.go

@@ -10,13 +10,10 @@ import (
 
 func resourceUser() *schema.Resource {
 	return &schema.Resource{
-		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.
-`,
+		Description: "`unifi_user` manages a user (or \"client\" in the UI) of the network, these are identified " +
+			"by unique MAC addresses.\n\n" +
+			"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.",
 
 		Create: resourceUserCreate,
 		Read:   resourceUserRead,

internal/provider/resource_user_group.go

@@ -9,10 +9,8 @@ import (
 
 func resourceUserGroup() *schema.Resource {
 	return &schema.Resource{
-		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.
-`,
+		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.",
 
 		Create: resourceUserGroupCreate,
 		Read:   resourceUserGroupRead,

internal/provider/resource_wlan.go

@@ -13,9 +13,8 @@ import (
 
 func resourceWLAN() *schema.Resource {
 	return &schema.Resource{
-		Description: `
-unifi_wlan manages a WiFi network / SSID.
-`,
+		Description: "`unifi_wlan` manages a WiFi network / SSID.",
+
 		Create: resourceWLANCreate,
 		Read:   resourceWLANRead,
 		Update: resourceWLANUpdate,

website/docs/data-sources/radius_profile.html.markdown

@@ -8,7 +8,7 @@ description: |-
 
 # Resource: `unifi_radius_profile`
 
-unifi_radius_profile data source can be used to retrieve the ID for a RADIUS profile by name.
+`unifi_radius_profile` data source can be used to retrieve the ID for a RADIUS profile by name.
 
 
 

website/docs/data-sources/user_group.html.markdown

@@ -8,7 +8,7 @@ description: |-
 
 # Resource: `unifi_user_group`
 
-unifi_user_group data source can be used to retrieve the ID for a user group by name.
+`unifi_user_group` data source can be used to retrieve the ID for a user group by name.
 
 
 

website/docs/data-sources/wlan_group.html.markdown

@@ -8,7 +8,7 @@ description: |-
 
 # Resource: `unifi_wlan_group`
 
-unifi_wlan_group data source can be used to retrieve the ID for a WLAN group by name.
+`unifi_wlan_group` data source can be used to retrieve the ID for a WLAN group by name.
 
 ## Example Usage
 

website/docs/resources/firewall_group.html.markdown

@@ -8,9 +8,22 @@ description: |-
 
 # Resource: `unifi_firewall_group`
 
-unifi_firewall_group manages groups of addresses or ports for use in firewall rules (unifi_firewall_rule).
+`unifi_firewall_group` manages groups of addresses or ports for use in firewall rules (`unifi_firewall_rule`).
 
+## Example Usage
 
+```terraform
+variable "laptop_ips" {
+  type = list(string)
+}
+
+resource "unifi_firewall_group" "can_print" {
+  name = "can-print"
+  type = "address-group"
+
+  members = var.laptop_ips
+}
+```
 
 ## Schema
 

website/docs/resources/firewall_rule.html.markdown

@@ -8,9 +8,27 @@ description: |-
 
 # Resource: `unifi_firewall_rule`
 
-unifi_firewall_rule manages an individual firewall rule on the gateway.
+`unifi_firewall_rule` manages an individual firewall rule on the gateway.
 
+## Example Usage
 
+```terraform
+variable "ip_address" {
+  type = string
+}
+
+resource "unifi_firewall_rule" "drop_all" {
+  name    = "drop all"
+  action  = "drop"
+  ruleset = "LAN_IN"
+
+  rule_index = 2011
+
+  protocol = "all"
+
+  dst_address = var.ip_address
+}
+```
 
 ## Schema
 

website/docs/resources/network.html.markdown

@@ -8,7 +8,7 @@ description: |-
 
 # Resource: `unifi_network`
 
-unifi_network manages LAN/VLAN networks.
+`unifi_network` manages LAN/VLAN networks.
 
 ## Example Usage
 

website/docs/resources/port_forward.html.markdown

@@ -8,7 +8,7 @@ description: |-
 
 # Resource: `unifi_port_forward`
 
-unifi_port_forward manages a port forwarding rule on the gateway.
+`unifi_port_forward` manages a port forwarding rule on the gateway.
 
 
 

website/docs/resources/user.html.markdown

@@ -3,20 +3,15 @@ subcategory: ""
 layout: ""
 page_title: "terraform-provider-unifi: unifi_user"
 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.
+  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.
 ---
 
 # Resource: `unifi_user`
 
-unifi_user manages a user (or "client" in the UI) of the network, these are identified
-by unique MAC addresses.
+`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.
+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.
 
 ## Example Usage
 

website/docs/resources/user_group.html.markdown

@@ -3,14 +3,12 @@ subcategory: ""
 layout: ""
 page_title: "terraform-provider-unifi: unifi_user_group"
 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.
+  unifi_user_group manages a user group (called "client group" in the UI), which can be used to limit bandwidth for groups of users.
 ---
 
 # Resource: `unifi_user_group`
 
-unifi_user_group manages a user group (called "client group" in the UI), which can be used
-to limit bandwidth for groups of users.
+`unifi_user_group` manages a user group (called "client group" in the UI), which can be used to limit bandwidth for groups of users.
 
 ## Example Usage
 

website/docs/resources/wlan.html.markdown

@@ -8,7 +8,7 @@ description: |-
 
 # Resource: `unifi_wlan`
 
-unifi_wlan manages a WiFi network / SSID.
+`unifi_wlan` manages a WiFi network / SSID.
 
 ## Example Usage