docs: document terraform-docs + ohmyzsh usage
#741
Merged
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
Signed-off-by: caerulescens <caerulescens.github@proton.me>
caerulescens
force-pushed
the
feature/ohmyzsh-usage
branch
from
fe80f50
to
3f4630c
Compare
khos2ow
approved these changes
Mar 15, 2024
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.
Description of your changes
Adds instructions for configuring
terraform-docscompletions withohmyzshshell.How has this code been tested
I use
terragrunt,terraform,terraform-docs, andohmyzsh(withterraformplugin)Versions:
Debian GNU/Linux 12 (bookworm)terraform-docs:terraform-docs version v0.17.0 795d369 linux/amd64omz:master (667fdbf)Steps:
linux/amd64terraform-docsinto/usr/bin/localomz reload(makesterraform-docsavailable on$PATH)terraform-docs completion zsh > ~/.oh-my-zsh/completions/_terraform-docsomz reloadResults:
Tab completing
terrawithinterraform-docsrepository for this pr's fork.Tab completing
terraform-docsshows options.Tab/Shift+Tab for selecting options.
closes #742