Skip to content

Commit 276be26

Browse files
committed
chore(xfer): update README.md (#438)
Post-tranfer update of `README.md` Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent 92cac4d commit 276be26

2 files changed

Lines changed: 33 additions & 24 deletions

File tree

.web-docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- markdownlint-disable first-line-h1 no-inline-html -->
22

3-
The Packer Plugin for VMware Desktop Hypervisors is a plugin that can be used to create virtual
4-
machine images for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro
5-
and VMware Workstation Pro.
3+
The Packer Plugin for VMware Desktop Hypervisors is a plugin for creating virtual machine images
4+
for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro and VMware
5+
Workstation Pro.
66

77
### Installation
88

@@ -28,8 +28,8 @@ packer plugins install github.com/vmware/vsphere
2828

2929
### Components
3030

31-
The plugin includes two builders which are able to create images, depending on your desired
32-
strategy.
31+
The plugin includes two builders for creating virtual machine images, depending on your desired
32+
strategy:
3333

3434
#### Builders
3535

README.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1+
<!--
2+
© Broadcom. All Rights Reserved.
3+
The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
4+
SPDX-License-Identifier: MPL-2.0
5+
-->
6+
7+
<!-- markdownlint-disable first-line-h1 no-inline-html -->
8+
19
# Packer Plugin for VMware Desktop Hypervisors
210

3-
The Packer Plugin for VMware Desktop Hypervisors is a plugin that can be used to create virtual
4-
machine images for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro
5-
and VMware Workstation Pro.
11+
The Packer Plugin for VMware Desktop Hypervisors is a plugin for creating virtual machine images
12+
for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro and VMware
13+
Workstation Pro.
614

7-
The plugin includes two builders which are able to create images, depending on your desired
15+
The plugin includes two builders for creating virtual machine images, depending on your desired
816
strategy:
917

1018
- [`vmware-iso`][docs-vmware-iso] - This builder creates a virtual machine, installs an operating
@@ -90,40 +98,41 @@ command `go build` from the repository root directory. Upon successful compilati
9098
To install the compiled plugin, please follow the Packer documentation on
9199
[installing a plugin][docs-packer-plugin-install].
92100

93-
### Configuration
101+
### Documentation
94102

95-
For more information on how to configure the plugin, please see the plugin documentation.
103+
For more information on how to use the plugin, please refer to the documentation.
96104

97105
- `vmware-iso` [builder documentation][docs-vmware-iso]
98106
- `vmware-vmx` [builder documentation][docs-vmware-vmx]
99107

100108
## Contributing
101109

102-
If you discover a bug or would like to suggest a feature or an enhancement, please use the GitHub
103-
[issues][issues]. Issues are monitored by the maintainers and are prioritized based on the
104-
criticality and community reactions.
110+
The Packer Plugin for VMware Desktop Hypervisors is the work of many contributors and the project team appreciates your help!
111+
112+
If you discover a bug or would like to suggest an enhancement, submit [an issue][issues].
105113

106-
Before opening an issue, please check existing open or recently closed issues to avoid duplicates.
114+
If you would like to submit a pull request, please read the [contribution guidelines][contributing] to get started. In case of enhancement or feature contribution, we kindly ask you to open an issue to discuss it beforehand.
107115

108-
When opening an issue, please include as much information as possible, such as:
116+
## Support
109117

110-
- A minimal reproducible example or a series of reproduction steps.
111-
- Details about your environment or deployment that might be unusual.
118+
The Packer Plugin for VMware Desktop Hypervisors is supported by the maintainers and the plugin community.
112119

113-
Please review the [contribution guidelines][contributing] before submitting a pull request.
120+
## License
114121

115-
For enhancements or features, please open an issue to discuss before submitting.
122+
© Broadcom. All Rights Reserved.
123+
The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
116124

117-
For comprehensive details on contributing, refer to the [contribution guidelines][contributing].
125+
The Packer Plugin for VMware Desktop Hypervisors is available under the [Mozilla Public License, version 2.0][license] license.
118126

127+
[license]: LICENSE
119128
[contributing]: .github/CONTRIBUTING.md
120129
[issues]: https://github.com/vmware/packer-plugin-vmware/issues
121130
[desktop-hypervisors]: https://www.vmware.com/products/desktop-hypervisor.html
122131
[docs-packer-init]: https://developer.hashicorp.com/packer/docs/commands/init
123132
[docs-packer-plugin-install]: https://developer.hashicorp.com/packer/docs/plugins/install-plugins
124-
[docs-vmware-iso]: https://developer.hashicorp.com/packer/plugins/builders/vmware/iso
125-
[docs-vmware-vmx]: https://developer.hashicorp.com/packer/plugins/builders/vmware/vmx
133+
[docs-vmware-iso]: https://developer.hashicorp.com/packer/integrations/vmware/vmware/latest/components/builder/iso
134+
[docs-vmware-vmx]: https://developer.hashicorp.com/packer/integrations/vmware/vmware/latest/components/builder/vmx
126135
[golang-install]: https://golang.org/doc/install
127136
[releases-vmware-plugin]: https://github.com/vmware/packer-plugin-vmware/releases
128-
[packer-plugin-vsphere]: https://developer.hashicorp.com/packer/plugins/builders/vsphere
137+
[packer-plugin-vsphere]: https://developer.hashicorp.com/packer/integrations/vmware/vsphere
129138
[download-vmware-ovftool]: https://developer.broadcom.com/tools/open-virtualization-format-ovf-tool/latest

0 commit comments

Comments
 (0)