[skip ci] Fix documentation generation and update docs #110
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
thefirstofthe300
requested review from
aaron-lane,
adrienthebo,
Jberlinsky and
morgante
as code owners
thefirstofthe300
force-pushed
the
ds/fix-documentation
branch
from
d1d4cd7
to
9718990
Compare
aaron-lane
suggested changes
Mar 21, 2019
thefirstofthe300
changed the title
thefirstofthe300
force-pushed
the
ds/fix-documentation
branch
from
9718990
to
d2f6d7c
Compare
The generate_docs function would attempt to run terraform_docs against the autogen/ directory. Since that directory contains templates instead of actual working Terraform, the terraform-docs command failed, causing no docs to be properly formatted. These changes update the function to properly ignore the ./autogen directory.
thefirstofthe300
force-pushed
the
ds/fix-documentation
branch
from
d2f6d7c
to
751b8b2
Compare
aaron-lane
approved these changes
Mar 25, 2019
CPL-markus
pushed a commit
to WALTER-GROUP/terraform-google-kubernetes-engine
that referenced
this pull request
Jul 15, 2024
…/ds/fix-documentation [skip ci] Fix documentation generation and update docs
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.
The generate_docs function would attempt to run terraform_docs against
the autogen/ directory. Since that directory contains templates instead
of actual working Terraform, the terraform-docs command failed, causing
no docs to be properly formatted.
These changes update the function to properly ignore the ./autogen
directory.
Also, updates the documentation.