-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
docs: Add cts_user_defined_meta option #9561
Merged
findkim
merged 1 commit into
hashicorp:nia/docs-0.1.0-beta
from
findkim:cts-user-defined-meta
Jan 14, 2021
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we'll want an example of this somewhere... it makes sense in abstract but I'm still not 100% on what it would look like. Obviously not in here, in the reference section, but somewhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 an example would be easier to follow. I don't know where I could write an example, if not here. Since we currently don't have a place for these edge case examples, would this section be so terrible as opposed to non-existent -- or do you have suggestions on places?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure where to put it at this point. I don't think the small examples in the configuration reference should get overloaded with all the different possible options, it gives the impressions that all those settings are needed. I'd say go ahead and merge this for now (ie. this is not a blocker) and we'll try to keep this in mind for the future. Maybe it can be worked into a learn guide or we could think about adding some documented examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for starting this discussion. Slept on this and a few ideas came up
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oooo. I personally like 3 for the less official-ness and potential to organize a 'library' of examples. Another thing to pair with the ideas, I’ve always liked how the Go documentation has the expand/collapse option for go-playground examples. It’s nice for users who are skimming and want a quick example vs. users who want to understand a feature in-depth.
Just threw out the thought! Probably not feasible right now - I couldn’t find precedence in our docs besides the sidebar navigation. And the example you have in mind may be larger than just an expand/collapse section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure! And I wasn't very clear - I was imagining that examples could be in an expand/collapse section in the configuration page (not for us to include our Go docs).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah even better. I like that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the wiki idea, but wiki's are terribly hard to keep up to date and almost needs a dedicated resource. Probably the best way to make them work is to get the community to do it, but I'm not sure if we'll be allowed to have an publicly editable wiki in a hashicorp repo. Github wiki permissions do support granting wiki edit permissions by themselves... so maybe partners/volunteers?
Another thing I was thinking of working into hashicat was to have the examples all run as tests. To have the examples and enforce keeping them up to date by making them part of the CI test suite.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't understand your difference between wiki / blog / learn guide upkeep? Other products publish blogs on describing new features (Terraform provider source, Vault 1.6) and aren't updated after published. These would be user-facing features and aren't pinned to implementation, and I imagine updates would involve breaking changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I was thinking more along the lines of documentation style examples, not blog posts. Using the wiki for informal blog posts is a much better idea that wouldn't have this sort of issues as people naturally understand that blog posts age.
So 👍 to that idea and sorry for the miscommunication.