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.

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

Consider using true/false for all booleans in docs #1660

Closed
kristianheljas opened this issue Mar 6, 2023 · 1 comment
Closed

Consider using true/false for all booleans in docs #1660

kristianheljas opened this issue Mar 6, 2023 · 1 comment

Comments

@kristianheljas
Copy link

Based on the community decision to use true/false for boolean values in documentation and examples, we ask that you evaluate booleans in this collection and consider changing any that do not use true/false (lowercase).

See documentation block format for more info (specifically, option defaults).

If you have already implemented this or decide not to, feel free to close this issue.


P.S. This is auto-generated issue, please raise any concerns here

softwarefactory-project-zuul bot pushed a commit that referenced this issue Mar 6, 2023
Use false instead of no in examples

SUMMARY
Use false instead of no in examples.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
vmware_deploy_ovf
vmware_guest_disk
vmware_guest_file_operation
vmware_guest_storage_policy
vmware_guest_vgpu_info
vmware_guest_vgpu
vmware_host_datastore
vmware_recommended_datastore
ADDITIONAL INFORMATION
#1660
@mariolenz mariolenz mentioned this issue Mar 7, 2023
softwarefactory-project-zuul bot pushed a commit that referenced this issue Mar 8, 2023
Issue1660 2

SUMMARY
Follow-up to #1661
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
vmware_host_inventory
vmware_vm_inventory
vcenter_standard_key_provider
vmware_cluster_drs
vmware_cluster_ha
vmware_cluster_info
vmware_cluster_vsan
vmware_datacenter_info
vmware_datastore_cluster
vmware_dvs_portgroup
vmware_dvswitch
vmware_dvswitch_uplink_pg
vmware_guest
vmware_guest_boot_manager
vmware_guest_disk
vmware_guest_file_operation
ADDITIONAL INFORMATION
#1660
softwarefactory-project-zuul bot pushed a commit that referenced this issue Mar 9, 2023
Issue 1660 part 3

SUMMARY
Follow-up to #1665
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
vmware_vm_inventory
vmware_guest_info
vmware_guest_instant_clone
vmware_guest_powerstate
vmware_guest_serial_port
vmware_host_facts
vmware_host_firewall_manager
vmware_host_service_manager
vmware_host
vmware_portgroup
vmware_vm_config_option
vmware_vm_host_drs_rule
vmware_vmkernel
vmware_vm_shell
vmware_vm_vm_drs_rule
vmware_vsan_health_info
vmware_vspan_session
vmware_vswitch
ADDITIONAL INFORMATION
#1660
softwarefactory-project-zuul bot pushed a commit that referenced this issue Mar 11, 2023
Issue 1660 part 4

SUMMARY
Follow-up to #1666
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/doc_fragments/vmware.py
plugins/doc_fragments/vmware_rest_client.py
plugins/connection/vmware_tools.py
plugins/inventory/vmware_host_inventory.py
plugins/inventory/vmware_vm_inventory.py
vcenter_domain_user_group_info
vcenter_extension
vcenter_folder
vcenter_standard_key_provider
vmware_category
vmware_cfg_backup
vmware_cluster_drs
vmware_cluster_info
vmware_content_deploy_ovf_template
vmware_content_deploy_template
vmware_content_library_info
vmware_content_library_manager
vmware_custom_attribute_manager
vmware_custom_attribute
vmware_datacenter_info
vmware_datacenter
vmware_datastore_cluster_manager
vmware_datastore_cluster
vmware_datastore_info
vmware_datastore_maintenancemode
vmware_datastore
vmware_deploy_ovf
vmware_dvs_host
vmware_dvs_portgroup_find
vmware_dvs_portgroup_info
vmware_dvs_portgroup
vmware_dvswitch_info
vmware_dvswitch_lacp
vmware_dvswitch_nioc
vmware_dvswitch_pvlans
vmware_dvswitch
vmware_dvswitch_uplink_pg
vmware_evc_mode
vmware_first_class_disk
vmware_guest_controller
vmware_guest_cross_vc_clone
vmware_guest_custom_attribute_defs
vmware_guest_custom_attributes
vmware_guest_customization_info
vmware_guest_disk_info
ADDITIONAL INFORMATION
#1660
softwarefactory-project-zuul bot pushed a commit that referenced this issue Mar 12, 2023
Issue 1660 part 5

SUMMARY
Follow-up to #1668
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
vmware_dvs_portgroup
vmware_guest_disk
vmware_guest_file_operation
vmware_guest_info
vmware_guest_instant_clone
vmware_guest_move
vmware_guest_network
vmware_guest_powerstate
vmware_guest
vmware_guest_register_operation
vmware_guest_serial_port
vmware_guest_snapshot_info
vmware_guest_snapshot
vmware_guest_tools_upgrade
vmware_guest_vgpu_info
vmware_guest_vgpu
vmware_host_acceptance
vmware_host_auto_start
vmware_host_custom_attributes
vmware_host_datastore
vmware_host_facts
vmware_host_firewall_manager
vmware_host_iscsi_info
vmware_host_iscsi
vmware_host_lockdown_exceptions
vmware_host_logbundle_info
vmware_host_logbundle
vmware_host_ntp
vmware_host_passthrough
vmware_host_powerstate
vmware_host
vmware_host_service_manager
vmware_host_sriov
vmware_local_role_manager
vmware_local_user_manager
vmware_maintenancemode
vmware_migrate_vmk
vmware_object_custom_attributes_info
vmware_object_rename
vmware_object_role_permission_info
vmware_object_role_permission
vmware_portgroup
vmware_recommended_datastore
vmware_resource_pool
vmware_tag_manager
ADDITIONAL INFORMATION
#1660
softwarefactory-project-zuul bot pushed a commit that referenced this issue Mar 13, 2023
Issue 1660 part 6

SUMMARY
Follow-up to #1669
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
various
ADDITIONAL INFORMATION
#1660
softwarefactory-project-zuul bot pushed a commit that referenced this issue Mar 13, 2023
Issue 1660 part 7

SUMMARY
Follow-up to #1671
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
various
ADDITIONAL INFORMATION
#1660
@mariolenz
Copy link
Collaborator

@kristianheljas I think I've fixed this in most places (#1661, #1665, #1666, #1668, #1669, #1671 and #1673). That is, in the DOCUMENTATION and EXAMPLES blocks in the files under plugins/.

I'm not sure yet what to do with the generated documentation, where booleans seem to be automatically given as yes / no: Wait on someone fixing / implementing ansible-network/collection_prep#81, switch to antsibull-doc or stop having this documentation here in the repo?

Well, I did what I could do at the moment and close this issue for now. Feel free to open a new issue whenever you find a place where we don't use true / false (lowercase).

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Mar 30, 2023
7.4.0

Major Changes
-------------

community.hrobot
~~~~~~~~~~~~~~~~

- firewall - Hetzner added output rules support to the firewall. This change unfortunately means that using old versions of the firewall module will always set the output rule list to empty, thus disallowing the server to send out packets (ansible-collections/community.hrobot#75, ansible-collections/community.hrobot#76).

community.vmware
~~~~~~~~~~~~~~~~

- Use true/false (lowercase) for boolean values in documentation and examples (ansible-collections/community.vmware#1660).

fortinet.fortios
~~~~~~~~~~~~~~~~

- Add annotations of member operation for every module.
- Update ``fortios.py`` for higher performance;
- supports temporary session key and pre/post login banner;
- update the examples on how to use member operation in Q&A.

purestorage.fusion
~~~~~~~~~~~~~~~~~~

- Patching of resource properties was brought to parity with underlying Python SDK, meaning the collection can create/update/delete all resource properties the SDK can
- fusion_volume - fixed and reorganized, arguments changed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants