docs: add READMEs for modules missing them (#117) - #238
Open
micheledaddetta-databricks wants to merge 1 commit into
Open
docs: add READMEs for modules missing them (#117)#238micheledaddetta-databricks wants to merge 1 commit into
micheledaddetta-databricks wants to merge 1 commit into
Conversation
Add README.md to the five module directories under `modules/` that contained Terraform code but had no README: - aws-databricks-workspace - gcp-unity-catalog - aws/aws-infra/modules/hub-networking - adb-data-storage-vnet-ncc-public-endpoint/adb-data-storage-vnet-ncc-private-endpoint - adb-data-storage-vnet-ncc-public-endpoint/adb-data-storage-vnet-ncc-public-endpoint Each README follows the repo convention: a hand-written intro plus a terraform-docs injected block (BEGIN_TF_DOCS/END_TF_DOCS). All pass `terraform-docs --output-check`. Co-authored-by: Isaac
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.
Summary
Closes #117.
Adds a
README.mdto the five directories undermodules/that contained Terraform code but had no README:modules/aws-databricks-workspacemodules/gcp-unity-catalogmodules/aws/aws-infra/modules/hub-networkingmodules/adb-data-storage-vnet-ncc-public-endpoint/adb-data-storage-vnet-ncc-private-endpointmodules/adb-data-storage-vnet-ncc-public-endpoint/adb-data-storage-vnet-ncc-public-endpointApproach
Each README follows the existing repo convention: a short hand-written intro describing what the module deploys and how to use it, followed by a
terraform-docs-generated block delimited by<!-- BEGIN_TF_DOCS -->/<!-- END_TF_DOCS -->(Requirements, Providers, Modules, Resources, Inputs, Outputs).The two
adb-data-storage-vnet-ncc-*submodules are near-identical VNet-injection + NCC deployments; the intros call out the distinction (Azure private endpoints + private DNS vs. storage service-endpoint network rules).Scope note
Only directories containing
.tffiles were treated as modules. Asset-only directories (images/,notebooks/,files/,.terraform/) were intentionally left without READMEs.Verification
terraform-docs -c .terraform-docs.yml --output-check <dir>passes ("up to date") for all five modules.end-of-file-fixer).This pull request and its description were written by Isaac.