docs: update documentation (#456)

Updates documentation.

Signed-off-by: Ryan Johnson <ryan@tenthirtyam.org>

Author: tenthirtyam

CODE_OF_CONDUCT.md .github/CODE_OF_CONDUCT.mdCODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

@@ -1,8 +1,8 @@
 <!-- markdownlint-disable first-line-h1 no-inline-html -->
 
-The Packer Plugin for VMware Desktop Hypervisors is a plugin that can be used to create virtual
-machine images for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro
-and VMware Workstation Pro.
+The Packer Plugin for VMware Desktop Hypervisors is a plugin that can be used to create
+virtual machine images for use with VMware [desktop hypervisors][desktop-hypervisors],
+VMware Fusion Pro and VMware Workstation Pro.
 
 ### Installation
 
@@ -20,7 +20,8 @@ packer {
 }
 ```
 
-Alternatively, you can use `packer plugins install` to manage installation of this plugin.
+Alternatively, you can use `packer plugins install` to manage installation of this
+plugin.
 
 ```sh
 packer plugins install github.com/vmware/vmware
@@ -33,13 +34,13 @@ strategy.
 
 #### Builders
 
-- `vmware-iso` - This builder creates a virtual machine, installs an operating system from an ISO,
-  provisions software within the operating system, and then exports the virtual machine as an image.
-  This is best for those who want to start by creating an image.
+- `vmware-iso` - This builder creates a virtual machine, installs a guest operating
+  system from an ISO, provisions software within the guest operating system, and then
+  exports the virtual machine as an image. Use this builder to start by creating a new
+  image.
 
-- `vmware-vmx` - This builder imports an existing virtual machine (from a`.vmx` file), runs
-  provisioners on the virtual machine, and then exports the virtual machine as an image. This is
-  best for those who want to start from an existing virtual machine as the source. You can feed the
-  artifact of this builder back into Packer to iterate on an image.
+- `vmware-vmx` - This builder imports an existing virtual machine, runs provisioners on
+  the virtual machine, and then exports the virtual machine as an image. Use this
+  builder to start from an existing image as the source.
 
 [desktop-hypervisors]: https://www.vmware.com/products/desktop-hypervisor.html

.web-docs/README.md

@@ -710,7 +710,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
 - `remote_type` (string) - No longer supported.
 
   ~> **Important:** VMware ESX is not supported by the plugin as of v2.0.0.
-  Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/hashicorp/vsphere).
+  Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/vmware/vsphere).
 
 <!-- End of code generated from the comments of the DriverConfig struct in builder/vmware/common/driver_config.go; -->
 

.web-docs/components/builder/iso/README.md

@@ -51,7 +51,7 @@ JSON Example:
 
 <!-- Code generated from the comments of the Config struct in builder/vmware/vmx/config.go; DO NOT EDIT MANUALLY -->
 
-- `source_path` (string) - Path to the source `.vmx`, '.ovf', or '.ova' file to clone.
+- `source_path` (string) - Path to the source `.vmx`, `.ovf`, or `.ova` file to clone.
 
 <!-- End of code generated from the comments of the Config struct in builder/vmware/vmx/config.go; -->
 
@@ -80,7 +80,7 @@ JSON Example:
 
 - `attach_snapshot` (string) - The name of an existing snapshot to which the builder shall attach the
   virtual machine before powering on. If no snapshot is specified the
-  virtual machine is started from its current state.  Default to
+  virtual machine is started from its current state. Defaults to
   `null/empty`.
 
 - `vm_name` (string) - This is the name of the `.vmx` file for the virtual machine, without
@@ -486,7 +486,7 @@ wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg
 - `remote_type` (string) - No longer supported.
 
   ~> **Important:** VMware ESX is not supported by the plugin as of v2.0.0.
-  Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/hashicorp/vsphere).
+  Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/vmware/vsphere).
 
 <!-- End of code generated from the comments of the DriverConfig struct in builder/vmware/common/driver_config.go; -->
 

.web-docs/components/builder/vmx/README.md

@@ -8,21 +8,21 @@ SPDX-License-Identifier: MPL-2.0
 
 # Packer Plugin for VMware Desktop Hypervisors
 
-The Packer Plugin for VMware Desktop Hypervisors is a plugin for creating virtual machine images
-for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro and VMware
-Workstation Pro.
+The Packer Plugin for VMware Desktop Hypervisors is a plugin for creating virtual
+machine images for use with VMware [desktop hypervisors][desktop-hypervisors], VMware
+Fusion Pro and VMware Workstation Pro.
 
-The plugin includes two builders for creating virtual machine images, depending on your desired
-strategy:
+The plugin includes two builders for creating virtual machine images, depending on your
+desired strategy:
 
-- [`vmware-iso`][docs-vmware-iso] - This builder creates a virtual machine, installs an operating
-  system from an ISO, provisions software within the operating system, and then exports the virtual
-  machine as an image. This is best for those who want to start by creating an image.
+- [`vmware-iso`][docs-vmware-iso] - This builder creates a virtual machine, installs a
+  guest operating system from an ISO, provisions software within the guest operating
+  system, and then exports the virtual machine as an image. Use this builder to start by
+  creating a new image.
 
-- [`vmware-vmx`][docs-vmware-vmx] - This builder imports an existing virtual machine (from a`.vmx`
-  file), runs provisioners on the virtual machine, and then exports the virtual machine as an image.
-  This is best for those who want to start from an existing virtual machine as the source. You can
-  feed the artifact of this builder back into Packer to iterate on an image.
+- [`vmware-vmx`][docs-vmware-vmx] - This builder imports an existing virtual machine,
+  runs provisioners on the virtual machine, and then exports the virtual machine as an
+  image. Use this builder to start from an existing image as the source.
 
 ## Supported Hypervisors
 
@@ -32,11 +32,12 @@ This plugin supports the following desktop hypervisors.
 - VMware Workstation Pro 17 (17.6.0 and later) for Linux and Windows
 
 > [!TIP]
-> Refer to the product documentation of the supported desktop hypervisors for system requirements.
+> Refer to the product documentation of the supported desktop hypervisors for system
+> requirements.
 
 > [!TIP]
-> To use the export functionality of the plugin, you must install [VMware OVF Tool][download-vmware-ovftool] 4.6.0 or
-> later.
+> To use the export functionality of the plugin, you must install [VMware OVF Tool][download-vmware-ovftool]
+> 4.6.0 or later.
 
 > [!IMPORTANT]
 > The plugin no longer supports VMware ESX as of version v2.0.0. 
@@ -51,22 +52,14 @@ This plugin supports the following desktop hypervisors.
 
   Required if building the plugin.
 
-## Usage
-
-For examples on how to use this plugin with Packer refer to the [example](example/) directory of
-the repository.
-
 ## Installation
 
-### Using Pre-built Releases
+### Using the Releases
 
 #### Automatic Installation
 
-Packer v1.7.0 and later supports the `packer init` command which enables the automatic installation
-of Packer plugins. For more information, see the [Packer documentation][docs-packer-init].
-
-To install this plugin, copy and paste this code (HCL2) into your Packer configuration and run
-`packer init`.
+Include the following in your configuration to automatically install the plugin when you
+run `packer init`.
 
 ```hcl
 packer {
@@ -80,49 +73,60 @@ packer {
 }
 ```
 
+For more information, please refer to the Packer [documentation][docs-packer-init].
+
 #### Manual Installation
 
-You can download the plugin from the GitHub [releases][releases-vmware-plugin]. Once you have
-downloaded the latest release archive for your target operating system and architecture, extract the
-release archive to retrieve the plugin binary file for your platform.
+You can install the plugin using the `packer plugins install` command.
 
-To install the downloaded plugin, please follow the Packer documentation on
-[installing a plugin][docs-packer-plugin-install].
+Examples:
 
-### Using the Source
+1. Install the latest version of the plugin:
 
-If you prefer to build the plugin from sources, clone the GitHub repository locally and run the
-command `go build` from the repository root directory. Upon successful compilation, a
-`packer-plugin-vmware` plugin binary file can be found in the root directory.
+    ```shell
+    packer plugins install github.com/vmware/vmware
+    ```
 
-To install the compiled plugin, please follow the Packer documentation on
-[installing a plugin][docs-packer-plugin-install].
+2. Install a specific version of the plugin:
 
-### Documentation
+    ```shell
+    packer plugins install github.com/vmware/vmware@v1.2.0
+    ```
 
-For more information on how to use the plugin, please refer to the [documentation][docs-vmware-plugin].
+### Using the Source
 
-## Contributing
+You can build from source by cloning the GitHub repository and running `make build` from
+the repository root. After a successful build, the `packer-plugin-vmware` binary is
+created in the root directory.
 
-The Packer Plugin for VMware Desktop Hypervisors is the work of many contributors and the project team appreciates your help!
+To install the compiled plugin, please refer to the Packer [documentation][docs-packer-plugin-install].
 
-If you discover a bug or would like to suggest an enhancement, submit [an issue][issues].
+## Documentation
 
-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.
+- Please refer to the plugin [documentation][docs-vmware-plugin] for more information on
+the plugin usage.
+
+- Please refer to the repository [`example`](example/) directory for usage examples.
+
+## Contributing
+
+Please read the [code of conduct][code-of-conduct] and [contribution guidelines][contributing]
+to get started.
 
 ## Support
 
-The Packer Plugin for VMware Desktop Hypervisors is supported by the maintainers and the plugin community.
+The Packer Plugin for VMware Desktop Hypervisors is supported by the maintainers and the
+plugin community.
 
 ## License
 
-© Broadcom. All Rights Reserved.
-The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
-
-The Packer Plugin for VMware Desktop Hypervisors is available under the [Mozilla Public License, version 2.0][license] license.
+© Broadcom. All Rights Reserved.</br>
+The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.</br>
+Licensed under the [Mozilla Public License, version 2.0][license].
 
 [license]: LICENSE
 [contributing]: .github/CONTRIBUTING.md
+[code-of-conduct]: .github/CODE_OF_CONDUCT.md
 [issues]: https://github.com/vmware/packer-plugin-vmware/issues
 [desktop-hypervisors]: https://www.vmware.com/products/desktop-hypervisor.html
 [docs-packer-init]: https://developer.hashicorp.com/packer/docs/commands/init

README.md

@@ -22,7 +22,7 @@ type DriverConfig struct {
 	// No longer supported.
 	//
 	// ~> **Important:** VMware ESX is not supported by the plugin as of v2.0.0.
-	// Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/hashicorp/vsphere).
+	// Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/vmware/vsphere).
 	RemoteType string `mapstructure:"remote_type" required:"false"`
 }
 

builder/vmware/common/driver_config.go

@@ -59,10 +59,10 @@ type Config struct {
 	Linked bool `mapstructure:"linked" required:"false"`
 	// The name of an existing snapshot to which the builder shall attach the
 	// virtual machine before powering on. If no snapshot is specified the
-	// virtual machine is started from its current state.  Default to
+	// virtual machine is started from its current state. Defaults to
 	// `null/empty`.
 	AttachSnapshot string `mapstructure:"attach_snapshot" required:"false"`
-	// Path to the source `.vmx`, '.ovf', or '.ova' file to clone.
+	// Path to the source `.vmx`, `.ovf`, or `.ova` file to clone.
 	SourcePath string `mapstructure:"source_path" required:"true"`
 	// This is the name of the `.vmx` file for the virtual machine, without
 	// the file extension. By default, this is `packer-BUILDNAME`, where

builder/vmware/vmx/config.go

@@ -8,6 +8,6 @@
 - `remote_type` (string) - No longer supported.
 
   ~> **Important:** VMware ESX is not supported by the plugin as of v2.0.0.
-  Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/hashicorp/vsphere).
+  Please use the [Packer plugin for VMware vSphere](https://developer.hashicorp.com/packer/integrations/vmware/vsphere).
 
 <!-- End of code generated from the comments of the DriverConfig struct in builder/vmware/common/driver_config.go; -->

docs-partials/builder/vmware/common/DriverConfig-not-required.mdx

@@ -20,7 +20,7 @@
 
 - `attach_snapshot` (string) - The name of an existing snapshot to which the builder shall attach the
   virtual machine before powering on. If no snapshot is specified the
-  virtual machine is started from its current state.  Default to
+  virtual machine is started from its current state. Defaults to
   `null/empty`.
 
 - `vm_name` (string) - This is the name of the `.vmx` file for the virtual machine, without

docs-partials/builder/vmware/vmx/Config-not-required.mdx

@@ -1,5 +1,5 @@
 <!-- Code generated from the comments of the Config struct in builder/vmware/vmx/config.go; DO NOT EDIT MANUALLY -->
 
-- `source_path` (string) - Path to the source `.vmx`, '.ovf', or '.ova' file to clone.
+- `source_path` (string) - Path to the source `.vmx`, `.ovf`, or `.ova` file to clone.
 
 <!-- End of code generated from the comments of the Config struct in builder/vmware/vmx/config.go; -->