Skip to content

docs: update README.md files#83

Merged
nywilken merged 3 commits intovmware:mainfrom
tenthirtyam:docs/update-readme
Aug 9, 2022
Merged

docs: update README.md files#83
nywilken merged 3 commits intovmware:mainfrom
tenthirtyam:docs/update-readme

Conversation

@tenthirtyam
Copy link
Copy Markdown
Collaborator

  • Updates README.md to follow the same structure as the Packer Plugin for vSphere project, including adding the Requirements section.

  • Simplifies docs/README.md to follow the same structure as the Packer Plugin for vSphere project and remove redundant content already provided in the default README.

Note:

Please review the requirements section. It is based on the content from the lower level iso.mdx and vmx.mdx content which mentions specific products. In particular, it mentioned VMware Player for Linux, but now Fusion Player (macOS) and Workstation Player (Windows and Linux) exist. As such, I kept it to Workstation Player (Linux) as it may need to be qualified for the Windows and macOS operating systems.

Note:

Further pull requests for iso.mdx and vmx.mdx docs are in the works to simplify, correct, and update the content.

Signed-off-by: Ryan Johnson johnsonryan@vmware.com

- Updates `README.md` to follow the same structure as the Packer Plugin for vSphere project, including adding the Requirements section.

- Simplifies `docs/README.md`  to follow the same structure as the Packer Plugin for vSphere project and remove redundant content already provided in the default README.

Signed-off-by: Ryan Johnson <johnsonryan@vmware.com>
@tenthirtyam tenthirtyam requested a review from a team as a code owner August 7, 2022 12:11
Added the context for `packer plugins install` cmd in Packer v1.8.0 and later.
Copy link
Copy Markdown
Contributor

@nywilken nywilken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. I really like the manual installation section. Will have to borrow for all the other plugin repos. Nicely done.

To install the plugin, please follow the Packer documentation on
[installing a plugin](https://www.packer.io/docs/extending/plugins/#installing-plugins).
For environments where the Packer host can not communicate with GitHub
(_e.g._, a dark-site), you can download [pre-built binary releases][releases-vmware-plugin]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😄

@nywilken nywilken merged commit dd81f50 into vmware:main Aug 9, 2022
@tenthirtyam tenthirtyam deleted the docs/update-readme branch August 18, 2022 02:42
@tenthirtyam tenthirtyam added this to the v1.0.8 milestone Dec 4, 2022
@vmware vmware locked and limited conversation to collaborators Jun 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants