Conversation
Contributor
|
Hey @SBGoods 👋 Definitely 👍 on handling this somehow, but I'm a little curious about two mutually exclusive ideas here:
|
…and directories directly managed by `tfplugindocs`
tfplugindocs managed files and subdirectories from rendered website directory
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Relates: hashicorp/terraform-provider-null#218
Previously,
tfplugindocswould remove the rendered website directory and all subdirectories if they exist before generating new website documentation. This method prevents documentation not managed bytfplugindocsto coexist in the website directory. This change modifies the generation to only remove subdirectories and files directly managed by the tool including: "data-sources", "guides", "resources", and "index.md".Due to the lack of existing end-to-end testing, this was verified by locally compiling and running against a branch of
terraform-provider-nullwhich had acdktfsubdirectory within docs. Running the command excludes thecdktfsubdirectory from deletion while still generating documentation from the templates and examples as expected.