Add subcategory support to the generate command#203
Open
remilapeyre wants to merge 1 commit intohashicorp:mainfrom
Open
Add subcategory support to the generate command#203remilapeyre wants to merge 1 commit intohashicorp:mainfrom
remilapeyre wants to merge 1 commit intohashicorp:mainfrom
Conversation
This patch adds a --subcategory flag that let users give a mapping that will use to set the `subcategory` field in the documentation: tfplugindocs generate --subcategory consul_acl=ACL --subcategory consul_admin="Admin Partition" The format for the flag is `prefix="Sub Category"` so all resources and datasources starting with `consul_acl` like `consul_acl_policy`, `consul_acl_token`, etc. will have the `subcategory: "ACL"` in the generated documentation. This is not very elegant but should work in most cases as needed. Closes hashicorp#156
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 patch adds a --subcategory flag that let users give a mapping that will use to set the
subcategoryfield in the documentation:The format for the flag is
prefix="Sub Category"so all resources and datasources starting withconsul_acllikeconsul_acl_policy,consul_acl_token, etc. will have thesubcategory: "ACL"in the generated documentation. This is not very elegant but should work in most cases as needed.Closes #156