hashicorp / hashicorp/terraform-plugin-docs

🐛 Documentation: acl_name description rendered as broken hyperlink on Registry

Open
#581 2 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Go
Stars
263
Forks
84
Avg merge
3d 6h
Merged PRs (30d)
2

Description

### Terraform CLI and terraform-plugin-docs Versions

## Problem
On the Terraform Registry documentation page for `volcenginecc_alb_acl`, the `acl_name` attribute description contains `http://` and `https://` as plain text, but the Registry **incorrectly renders them as clickable hyperlinks**, breaking the readability.
**Registry page:** https://registry.terraform.io/providers/volcengine/volcenginecc/latest/docs/resources/alb_acl

## Reproduction
The same description renders **correctly** in the official Terraform Doc Preview tool:
🔗 https://registry.terraform.io/tools/doc-preview?product_intent=terraform
This suggests the issue is on the **Registry rendering side**, not in the source markdown.
## Source Description
```
- `acl_name` (String) Name of the Access Control Policy Group. Cannot start with http:// or https://. Must begin with a letter or Chinese character and may include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If left blank, defaults to the Access Control Policy Group ID.
```

### Provider Code

```go
volcenginecc
```

### Expected Behavior

### Expected
> Cannot start with `http://` or `https://`.

### Actual Behavior

### Actual
> Cannot start with [http://](http://) or [https://](https://).
The `http://` and `https://` are parsed as URLs and turned into `` tags.

### Steps to Reproduce

1. `tfplugindocs generate --flags`

### How much impact is this issue causing?

Low

### Logs

_No response_

### Additional Information

_No response_

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.