terraform-provider-nsxt icon indicating copy to clipboard operation
terraform-provider-nsxt copied to clipboard

Wrong line indentation in the nsxt_policy_segment documentation

Open BergCyrill opened this issue 2 years ago • 2 comments

Describe the bug

In the documentation for the nsxt_policy_segment resource is a wrong indentation of required attributes: ...

  • dhcp_option_121 - (Optional) DHCP classless static routes.
  • network - (Required) Destination in cidr format.
  • next_hop - (Required) IP address of next hop.
  • dhcp_generic_option - (Optional) Generic DHCP options.
  • code - (Required) DHCP option code. Valid values are from 0 to 255.
  • values - (Required) List of DHCP option values.

...

Should be: ...

  • dhcp_option_121 - (Optional) DHCP classless static routes.
    • network - (Required) Destination in cidr format.
    • next_hop - (Required) IP address of next hop.
  • dhcp_generic_option - (Optional) Generic DHCP options.
    • code - (Required) DHCP option code. Valid values are from 0 to 255.
    • values - (Required) List of DHCP option values.

...

Reproduction steps

1. follow documentation

Expected behavior

Right indentation in the documentation

Additional context

No response

BergCyrill avatar Aug 17 '22 15:08 BergCyrill

Looks correct in the markdown..

https://github.com/vmware/terraform-provider-nsxt/blob/866e72278ce144c181fb6750c6ce976f5f3effda/website/docs/r/policy_segment.html.markdown?plain=1#L74-L79

But it's not rendering correctly on the Terraform Registry. Appears to be a limitation of the the Registry's documentation rendering. I recommend including them in a sentence structure.

Example:

  * `dhcp_v4_config` - (Optional) DHCPv4 config for IPv4 subnet. This clause is supported with NSX 3.0.0 onwards.
     * `server_address` - (Optional) IP address of the DHCP server in CIDR format. This attribute is required if segment has provided dhcp_config_path and it represents a DHCP server config.
     * `dns_servers` - (Optional) List of IP addresses of DNS servers for the subnet.
     * `lease_time`  - (Optional) DHCP lease time in seconds.
     * `dhcp_option_121` - (Optional) DHCP classless static routes. 
       `network` in cidr format (required), and `next_hop` IP address (required).

Recommended Label: documentation

Ryan Johnson Senior Staff Solutions Architect | Product Engineering @ VMware, Inc.

tenthirtyam avatar Aug 17 '22 15:08 tenthirtyam

Yes indeed its a rendering issue, the markdown is correct.

annakhm avatar Aug 30 '22 16:08 annakhm