[DOCS] "GETTING STARTED WITH VMWARE" needs a improvement.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
URL: https://docs.saltproject.io/en/latest/topics/cloud/vmware.html needs improvement
- the VMware link under "image" is broken. the SDK link re-directs to a generic page.
- Please add an example of win_run_once and fix the description.
Suggested Fix
The valid SDK link for the image: https://vdc-download.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
win_run_once: this can only be done with customization: true. Also Please add clarity that the script that is to be executed must remain on the template.
syntax that worked for me:
win_run_once: 'powershell.exe c:\scripts\en.winrm.ps1'
There are certain tasks that can only take place with customization: true. Ie:
- setting up hostname
- setting up IP address
- setting up gateway
- Setting up DNS
- domain join (if invoking this via vmw customization API)
- GUI.Runonce
It would be good to have this specified explicitly under customization: true
Type of documentation
salt.cloud documentation for VMware
Location or format of documentation
https://docs.saltproject.io/en/latest/topics/cloud/vmware.html
Additional context
the slack conversation here: https://vmware.slack.com/archives/C01CW4Q57BP/p1617954361137200
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the VMware cloud documentation at topics/cloud/vmware.html and inspect the image and customization sections. Check the suggested VMware SDK link, document the win_run_once example and customization requirements, and verify that the page clearly covers the listed customization tasks and template-script requirement.
Written by the indexing model from the issue text.
Assessment
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100