fix: Enable control of docs by provider authors #1024
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
This enables the Docker provider to explicitly embed `{{% examples %}}` after
introductory text, unblocking:
- pulumi/pulumi-docker#592
- pulumi/pulumi-docker#588
This fix addresses this issue:
- pulumi/pulumi-docker#600
All of these might be fixed by a change to Docker that added introductory text
above examples, but as observed in pulumi/pulumi-docker#600, it's not currently
possible to render text outside of an examples block.
This change to docs rendering allows us to explicitly add the examples shortcode
block in the input docs, and pass-through tfgen rendering entirely.
t0yv0
approved these changes
Apr 21, 2023
|
Diff for pulumi-azuread with merge commit 4eb02ce |
|
Diff for pulumi-random with merge commit 4eb02ce |
iwahbe
approved these changes
Apr 21, 2023
|
Diff for pulumi-gcp with merge commit 4eb02ce |
|
Diff for pulumi-azure with merge commit 4eb02ce |
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.
This enables the Docker provider to explicitly embed
{{% examples %}}after introductory text, unblocking:Imageto use Buildkit inline caching pulumi-docker#592destroypulumi-docker#588This fix addresses this issue:
All of these might be fixed by a change to Docker that added introductory text above examples, but as observed in pulumi/pulumi-docker#600, it's not currently possible to render text outside of an examples block.
This change to docs rendering allows us to explicitly add the examples shortcode block in the input docs, and pass-through tfgen rendering entirely.