Repository navigation
docs(modules): fix the datafusion-se README example and accelerators row - #354
Merged
aghassemlouei merged 1 commit intoOct 24, 2026
Conversation
The README example for the modules/datafusion-se module pointed at the upstream modules/datafusion module, read blueprint variables and depended on a KMS binding that it never declared, under a heading that said "Without CMEK". The example now calls the datafusion-se module with placeholder values and the kms_key input, under a heading that matches. A blank line between the type and the default of the accelerators variable made the tools/tfdoc.py script render the default inside the type and list the variable as required. Removing the blank line fixes the row, and the script regenerates the variables table.
aghassemlouei
approved these changes
Oct 24, 2026
aghassemlouei
left a comment
Member
There was a problem hiding this comment.
Thank you for fixing the modules/datafusion-se example and the accelerators variable table formatting. We validated the updated README.md example with terraform init and terraform plan (Plan: 3 to add, 0 to change, 0 to destroy) and verified tools/check_documentation.py.
Merged
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
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
The
modules/datafusion-semodule README now shows a working example and an accurate variables table.modules/datafusionmodule instead ofmodules/datafusion-se.var.*values from theblueprints/fedramp-high/datafusionblueprint and depended on a KMS binding that it never declared.datafusion-semodule with placeholder values and thekms_keyinput, under the "Private instance with CMEK" heading.acceleratorsvariable made thetools/tfdoc.pyscript renderdefault = nullinside the type column and mark the variable as required. Removing the blank line fixes the row. Terraform already parsed the variable correctly, so the module behavior stays the same.No issue exists for this change. A comparison against upstream Fabric during the sync in #311 surfaced it.
Type of Change
Deployment & Compliance Impact
Checklist
Code Quality & Reusability
modules/orfast/stages-aw/can be leveraged for this change.docs/naming-convention.md.Documentation
README.mdof the modified module or blueprint.Security
Testing
Testing Performed
terraform fmt -checkpasses for themodules/datafusion-semodule.modules/datafusion-semodule, passesterraform init -backend=falseandterraform validate.tools/tfdoc.pyscript regenerates the variables table, and thetools/check_documentation.pyscript passes for all modules.tools/check_links.pyscript passes for themodules/datafusion-semodule.