Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation for the vmx_data_post configuration option to accurately reflect that it is applied after the virtual machine build is complete, rather than after the virtual machine is started. The PR also removes bold formatting from timing-related words ("before" and "after") in both vmx_data and vmx_data_post descriptions for consistency. The changes are made in the source code comments and propagated to all generated documentation files via make generate.
Key Changes
- Corrected
vmx_data_postdescription from "after the virtual machine is started" to "after the virtual machine build is complete" - Removed bold markdown formatting from "before" and "after" timing indicators for cleaner documentation style
- Updated all generated documentation files to reflect these changes
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
builder/vmware/common/vmx_config.go |
Source of truth: Updated comments for VMXData and VMXDataPost fields to correct timing and remove bold formatting |
docs-partials/builder/vmware/common/VMXConfig-not-required.mdx |
Generated documentation partial updated via make generate |
.web-docs/components/builder/vmx/README.md |
Generated VMX builder documentation updated via make generate |
.web-docs/components/builder/iso/README.md |
Generated ISO builder documentation updated via make generate |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Updated comments and documentation to specify that `vmx_data_post` is applied after the virtual machine build is complete, rather than after the virtual machine is started. This improves clarity for advanced users configuring VMX options. Ran `make generate` to generate the documentation from the codebase. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
810b5ab to
64893da
Compare
|
This functionality has been released in v2.0.0 of the plugin. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
1 similar comment
|
This functionality has been released in v2.0.0 of the plugin. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
|
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 issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Description
Updated comments and documentation to specify that
vmx_data_postis applied after the virtual machine build is complete, rather than after the virtual machine is started. This improves clarity for advanced users configuring VMX options.Ran
make generateto generate the documentation from the codebase.Reference
Ref: #400
Rollback Plan
Revert commit.
Changes to Security Controls
None.