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 unrendered "example" section #23

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Rindrics
Copy link

@Rindrics Rindrics commented Oct 23, 2024

Chores

  • execute tfplugindocs migrate to let preexistent "Example Usage" section being recognized by registry website

Before/After applying this PR

Before

"Example Usage" section is not shown on site although it exists in the code:
https://registry.terraform.io/providers/SigNoz/signoz/0.0.4/docs/resources/alert

After

"Example Usage" section is recognized and shown on site:
https://registry.terraform.io/providers/Rindrics/signoz/0.0.1/docs/resources/alert

Note

  • I wanted to delete & ignore docs/*, but left it as it is because we cannot dynamically include them to the releases

@Rindrics Rindrics requested a review from a team as a code owner October 23, 2024 17:50
@grandwizard28
Copy link
Collaborator

Thank you for your contribution @Rindrics

@Rindrics Rindrics marked this pull request as draft October 23, 2024 18:16
@Rindrics
Copy link
Author

thanks, I converted this PR to draft because I found something to check.

@Rindrics Rindrics marked this pull request as ready for review October 24, 2024 12:25
@Rindrics
Copy link
Author

Rindrics commented Oct 24, 2024

I surveyed whether we can remove & ignore docs/ but finally found we cannot.

@Rindrics
Copy link
Author

would you take a look at this PR? @grandwizard28

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