Update documentation for Virtualization module
Open
Nobody has claimed this yet.
- Dominant language
- Perl
- Stars
- 737
- Forks
- 214
- PR merge metrics
- No merged PRs in 30d
Description
Documentation for http://www.rexify.org/docs/api/1.3/rex/commands/virtualization.pm.html could be updated to cover all the possibilities supported by this module.
For example, there's no info that it's actually possible to create a KVM guest and set a MAC address for it.
P.S. My first issue here. Rex is awesome!
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
Read the linked API documentation for rex/commands/virtualization.pm and compare it with the virtualization module's supported possibilities. Start with the KVM guest and MAC-address cases named in the issue; done means the documentation covers the module's supported capabilities, including those examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- perl
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100