Generate CR docs #205
Merged
Generate CR docs #205
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
lblackstone
approved these changes
Oct 4, 2021
| // - AWS: "s3://<my-pulumi-state-bucket>" | ||
| // - Azure: "azblob://<my-pulumi-state-bucket>" | ||
| // - GCP: "gs://<my-pulumi-state-bucket>" | ||
| // (optional) Backend is an optional backend URL to use for all Pulumi operations.<br/> |
There was a problem hiding this comment.
It seems odd to include HTML snippets in Go comments
There was a problem hiding this comment.
Yeah consider this to just be a stop-gap for now... I am still investigating a better alternative for the documentation generation. In this instance, the rendering is busted without the embedded line breaks.
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.
Proposed changes
Uses https://github.com/fybrik/crdoc to generate rudimentary docs for
StackCR.Related issues (optional)
Fixes #173