Fix-up docs templates #236
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We've updated the version of tfplugin-docs which has exposed issues with
the existing resource templates. As a result of a change in indentation
in the generated "description" field of the the .md files resulting from
the resource templates the documentation wasn't being categorised
correctly on the provider registry landing page. To fix this we make
the following change in each template:
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
becomes
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
reubenur-rahman
approved these changes
Jun 10, 2024
mahesh-hpe
approved these changes
Jun 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We've updated the version of tfplugin-docs which has exposed issues with the existing resource templates. As a result of a change in indentation in the generated "description" field of the the .md files resulting from the resource templates the documentation wasn't being categorised correctly on the provider registry landing page. To fix this we make the following change in each template:
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
becomes
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}