Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Odd documentation generation with upgrade to version 0.19.0 #360

Closed
1 task done
PatrickRice-KSC opened this issue Apr 19, 2024 · 3 comments · Fixed by #361
Closed
1 task done

Odd documentation generation with upgrade to version 0.19.0 #360

PatrickRice-KSC opened this issue Apr 19, 2024 · 3 comments · Fixed by #361
Labels
bug Something isn't working

Comments

@PatrickRice-KSC
Copy link

Terraform CLI and terraform-plugin-docs Versions

Terraform version: 1.4.0
Plugin docs version: v0.19.0

Provider Code

https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1888/diffs#9d055e3689fb5193976798648b837563c2baeeb0

Expected Behavior

  • Headers for nested data source schemas includes the name of the attribute
  • All description content is included in the front matter as expected

Actual Behavior

  • Headers for nested data source schemas seem to be removing the name of the attribute
  • One link seems to be removed from the "description" front matter of the generated files

Steps to Reproduce

  1. tfplugindocs generate

How much impact is this issue causing?

Low

Logs

No response

Additional Information

Is this potentially related to ab779d3 ? It seems like the attribute schemas were being properly generated in v0.18.0 though, I don't think an empty header is a great user experience here :)

Code of Conduct

  • I agree to follow this project's Code of Conduct
@SBGoods
Copy link
Contributor

SBGoods commented Apr 19, 2024

Hi @PatrickRice-KSC 👋🏾,
I'm sorry that you're running into trouble here. The issue that you are facing with your headers looks similar to a bug reported in #356 where the headers were not rendering properly for nested object attributes. A fix #357 has been merged in main and will be released in v0.19.1 early next week.

The issue where the URL has been removed from the description in your docs is a bug related to the plainmarkdown function which I've opened a PR for the fix in #361. This fix will also be included in the next v0.19.1 patch release.

@PatrickRice-KSC
Copy link
Author

@SBGoods - thanks for the quick response and that sounds great! We'll close out the current Renovate MR and just wait for the next release!

Copy link

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants