Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

More consistent VMware module docs #43433

Closed
dagwieers opened this issue Jul 30, 2018 · 44 comments
Closed

More consistent VMware module docs #43433

dagwieers opened this issue Jul 30, 2018 · 44 comments
Assignees
@dagwieers
Labels
affects_2.7 This issue/PR affects Ansible v2.7 cloud docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team. vmware VMware community

Comments

@dagwieers
Copy link
Contributor

dagwieers commented Jul 30, 2018 •
edited by goneri
Loading

SUMMARY

Looking at the various modules documentation there is a lot to gain from making the module docs more consistent:

  • Make use of the same standard for connecting to vCenter Fix all VMware examples to use delegate_to #43426
  • Harmonize the example values for connection parameters
    • Order them consistently
    • Use real-life values (instead of stub variables or placeholders)
  • Show how to connect to vCenter and ESXi consistently (not all modules do this well)
  • Add a proper description for every example
  • Add type information to all parameters (so it's more obvious to users)
  • Use different items in parameter docs rather than one large blob
    • The first line explains the parameter
    • Subsequent lines describe modalities and explain values
  • Link the VMware guide in the vmware doc fragments (so people can click through)
ISSUE TYPE
  • Documentation Report
COMPONENT NAME

vmware

ANSIBLE VERSION

v2.7 and older
@dagwieers dagwieers added the vmware VMware community label Jul 30, 2018
@dagwieers dagwieers added this to the 2.8.0 milestone Jul 30, 2018
@dagwieers dagwieers self-assigned this Jul 30, 2018
@dagwieers dagwieers mentioned this issue Jul 30, 2018
Merged
@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Jul 30, 2018

cc @Akasurde @bedecarroll @chrrrles @dav1x @garbled1 @imjoseangel @jjahns @kamsz @lrivallain @nafpliot-ibm @nerzhul @oboukili @pdellaert @ritzk @sivel @tchernomax @warthog9 @woshihaoren
click here for bot help

@ansibot ansibot added affects_2.7 This issue/PR affects Ansible v2.7 cloud docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. support:community This issue/PR relates to code supported by the Ansible community. labels Jul 30, 2018
@dagwieers dagwieers mentioned this issue Jul 30, 2018
Closed
@imjoseangel
Copy link
Contributor

What is the process for this kind of issues involving multiple files? Modifying all at once or every contributor takes care of single modules?

@Akasurde
Copy link
Member

@imjoseangel it depends. You can do it in multiple chunk of files or do it all files together. Also, you can do it in multiple files in several commits which makes it easy to review.

@dagwieers
Copy link
Contributor Author

@imjoseangel Since we still have to decide what's best for each of the items, there's no use in having every module owner to start to modifying their modules. TBH I wasn't expecting @ansibot to mark every VMware module and notify every module owner. Once I made the PR with the changes I have in mind this would have been more useful. So my preference goes to a single PR with all changes, that can be discussed in that PR.

@ansibot

This comment has been minimized.

Sign in to view
@ansibot

This comment has been minimized.

Sign in to view
@bcoca bcoca removed this from the 2.8.0 milestone Aug 28, 2018
@ansibot

This comment has been minimized.

Sign in to view
@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Sep 13, 2018

cc @rmin
click here for bot help

@ansibot ansibot added the support:core This issue/PR relates to code supported by the Ansible Engineering Team. label Sep 21, 2018
@ansibot ansibot removed the support:core This issue/PR relates to code supported by the Ansible Engineering Team. label Oct 7, 2018
@dagwieers dagwieers mentioned this issue Oct 18, 2018
Closed
This was referenced Oct 19, 2018
Merged
Closed
@gundalow gundalow mentioned this issue Oct 24, 2018
Merged
@ansible ansible deleted a comment from ansibot Oct 25, 2018
@ansible ansible deleted a comment from ansibot Oct 25, 2018
@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Feb 25, 2019

cc @michaeldeaton
click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Mar 13, 2019

cc @sumkincpp
click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Mar 29, 2019

cc @GBrawl
click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented May 8, 2019

cc @CastawayEGR @goneri
click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented May 17, 2019

cc @davidmhewitt
click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Jun 2, 2019

cc @pgbidkar
click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Jul 4, 2019

cc @vmwjoseph
click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansibot ansibot added the has_pr This issue has an associated PR. label Jul 28, 2019
@ansibot
Copy link
Contributor

ansibot commented Aug 8, 2019

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansibot ansibot added the deprecated This issue/PR relates to a deprecated module. label Sep 1, 2019
@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Sep 9, 2019

cc @equelin
click here for bot help

@ansibot

This comment has been minimized.

Sign in to view
@ansibot
Copy link
Contributor

ansibot commented Sep 17, 2019

cc @n3pjk
click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Sep 17, 2019

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot removed deprecated This issue/PR relates to a deprecated module. module This issue/PR relates to a module. labels Sep 17, 2019
@ansibot
Copy link
Contributor

ansibot commented Mar 27, 2020

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added support:core This issue/PR relates to code supported by the Ansible Engineering Team. and removed support:community This issue/PR relates to code supported by the Ansible community. labels Mar 27, 2020
@ansibot ansibot added the needs_triage Needs a first human triage before being processed. label May 16, 2020
@mkrizek mkrizek removed the needs_triage Needs a first human triage before being processed. label May 18, 2020
@Akasurde
Copy link
Member

Thank you very much for your interest in Ansible. This plugin is no longer maintained in this repository and has been migrated to https://github.com/ansible-collections/community.vmware.

Please re-submit this issue in the above repository.

If you have further questions please stop by IRC or the mailing list:

@ansible ansible locked and limited conversation to collaborators Sep 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@dagwieers dagwieers

Labels
affects_2.7 This issue/PR affects Ansible v2.7 cloud docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team. vmware VMware community
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@dagwieers @Akasurde @bcoca @mkrizek @imjoseangel @ansibot