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

Fix typo in project resource documentation #173

Merged
merged 1 commit into from
Nov 11, 2024
Merged

Conversation

grig777
Copy link
Contributor

@grig777 grig777 commented Nov 11, 2024

I have identified and fixed a typo in the documentation file project.md. This file appears to be autogenerated by the terraform-plugin-docs plugin, but I wasn't able to determine the exact source of the typo from the code base. As a result, I made a direct modification to the markdown file.

If this is not the correct way to address this issue and the typo should instead be fixed from the original source that generates the file, I fully understand. Please feel free to close this PR, and open a new one with the correct fix.

@grig777 grig777 requested a review from alexhung as a code owner November 11, 2024 19:29
Copy link

github-actions bot commented Nov 11, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@grig777
Copy link
Contributor Author

grig777 commented Nov 11, 2024

I have read the CLA Document and I hereby sign the CLA

@alexhung
Copy link
Member

alexhung commented Nov 11, 2024

@grig777 Thanks for the PR. I think this section/line of the doc is out-of-date. I can't find it in the code either. This is likely due to the fact that terraform-plugin-docs is completely confused by the fact we have a resource project with same name as the provider project and it generates wrong output for all the resources. Thus I have been manually updating doc and probably missed this section.

While your PR is correct, I think I need to give all the resource docs a once over to ensure everything is up-to-dated.

@alexhung alexhung merged commit b8703ea into jfrog:master Nov 11, 2024
1 of 2 checks passed
@alexhung
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants