expand README files for examples #1946
Merged
Conversation
This file contains hidden or 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
bpmct
approved these changes
Jun 1, 2022
There was a problem hiding this comment.
Nice, thanks for doing this! This is a larger question beyond this PR, but:
- do you have thoughts on how the product can refer to these docs during template creation? We have found that in many cases, we want to recommend users make edits to the TF instead of using the built-in example to manage access/secrets in their preferred way.
- I noticed some of this info is repeated based on the cloud configuration, not the template itself. Perhaps not a big deal yet, but we may be able to find another solution once we build a static docs site
|
@bpmct let me think a bit re: your questions and I'll get back to you! |
Co-authored-by: Ben Potter <ben@coder.com>
bpmct
approved these changes
Jun 6, 2022
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.
Currently features the following so that no one sees empty files:
I'm open to any and all changes suggested. I'm tracking #1321 for future additions regarding troubleshooting